Authentication

How to create an API key

  1. Login to the Partner Portal
  2. Navigate to the Developer section in the left hand menu. (If you can't see this, you will need to ensure your user account has the correct role.)
  3. Select the API keys tab.
  4. Click the Generate API Key button and give your key a name.
  5. Click Generate and copy the generated key. Note that you cannot access it again once you close the modal.

❗️

Warning

Never give out or embed your access token in your front end of public repositories. Treat it like a password that gives access to your most sensitive data.

Lifetime

Access tokens are long lived and will never expire unless they are manually revoked.

Usage

The header below must be included with all REST requests. (replacing {{API_TOKEN}} with your valid token)

X-API-Key: {{API_TOKEN}}