We'll walk you through the process of creating, managing, and using API keys for authentication. API keys are composed of an ID and a secret, providing a secure way to interact with our API. We've organized this guide into sections to cover key aspects of API key management.

Creating an API Key

All API keys are shared by the account, so if you create a key, it will be available to all users of your account.

Step 1: Access API Key Management

Visit the API Key section in the platform - it's available for demo or for production. Here, you can view, create, and manage your API keys.

Step 2: Add a New API Key

Click on the "Add New API Key" button. Give your API key a descriptive name to easily identify its purpose later.

Note: You should create different API keys for different use cases. There is a limit of three keys that can be active for any one account. If you would like to create more keys than this, please contact your account manager.

Step 4: Obtain API Key ID and Secret

Once created, your API key will be assigned a unique ID and a secret. These credentials are essential for authenticating your requests.

Managing API Keys

Viewing API Keys

Navigate to the API Key section to view a list of all your created keys. Here, you can see the names, IDs, and manage the lifecycle of each key.

Deleting API Keys

If you no longer need an API key, simply select the key and choose the option to delete it. Be cautious, as this action is irreversible.

Recycle API Secret

You cannot currently cycle the secret of a key directly, you should instead create a new key and switch over your application's usage to the new one, and then delete the old one when that step is completed.

Secrets

You will use both the ID and the secret to make a call to our OAuth2 token endpoint, to get an authentication token.

Usage and Security

The API key secret is sensitive information and should be treated with utmost care. Ensure that it is securely stored and never exposed in client-side code or public repositories.

One-Time Viewing

For enhanced security, you can only view the secret once during the creation process. Make sure to store it in a secure location for future use. If you lose it, you'll need to create a new key.

Scopes

Scopes define the permissions associated with your API key. Each API key is assigned specific scopes that determine the actions it can perform.

You cannot adjust the scopes for an API key once it has been created. You should create a new key if you need to change the scopes, and then delete the old unused key once you have updated your application.

Understanding Scopes

Explore the available scopes in our documentation to understand the level of access each scope provides. Choose scopes that align with the functionality you need for your application.

Next Steps

Now that you have an API key, you can get an access token.