Skip to main content

How to use API Access

This guide explains how to:

  1. Request an API key from Publisher Champ
  2. Grant API access to another Publisher Champ user
  3. Revoke API access later if needed

You can find this page in Publisher Champ at My Account > Settings > API Access.

Before you start​

To use the API, the receiving account must have an API key assigned.

You will also need a new active paid subscription for the separate API account, to cover the cost of API access.

If you do not already have an API key, contact us and we can generate one for you:

Where to find API Access​

  1. Log in to Publisher Champ
  2. Go to My Account Settings
  3. Open the API Access tab

Requesting an API key​

If your account does not have an active API key yet, the API Access tab will show a message letting you know.

Contact us through:

Once we assign an API key to your account, it will appear in the API Access tab.

About +api email aliases​

When we suggest creating an email like yourname+api@example.com, we mean using an email alias technique often called plus addressing or subaddressing.

Example:

  • Regular address: yourname@example.com
  • API-only alias: yourname+api@example.com

With providers that support plus addressing, both emails still go to the same inbox. This makes it easy to:

  • Keep your API-only Publisher Champ account separate from your main login
  • See instantly which emails relate to API access
  • Create inbox filters or labels just for API-related messages

Important:

  • Not every email provider supports + aliases
  • If your provider does not support them, use any other email address you control
  • A mailbox alias or forwarding address also works fine

Grant API access to another user​

Use this when you want another Publisher Champ user to access your account by API.

  1. Open the API Access tab
  2. In Share Your Account By API, enter the recipient's email address
  3. Click Grant Access
  4. Confirm the action

After this:

  • The other user can use their own API key
  • They can use your account_id
  • Your account will appear in their Account IDs You Can Use section
note

The receiving user must already have an API key assigned, otherwise the grant cannot be created.

Revoke API access​

You can remove API access at any time.

  1. Open the API Access tab
  2. In Who Has Access, find the email address
  3. Click Revoke
  4. Confirm the action

Once revoked, that user will no longer have explicit API access to your account.

What the other user sees​

If the receiving user has an active API key, they will see:

  • Their assigned api_key
  • The account_id values they can use

They can then call the API with:

  • Their own api_key
  • The granted account's account_id

Summary​

  • Ask us to generate an API key if your account does not have one yet
  • Use the API Access tab to grant access by email
  • Use the same tab to revoke access later
  • The receiving user must have an assigned API key for the shared account to appear