Managing API Keys

An API key is required to make authorised requests to the API. The key needs to be sent with all requests as described in the API specification.

How to Add an API Key

From the Partner Portal:

Navigation to API Key Management

Go to Settings in the portal's top right. From the dropdown, select Company Settings and then API keys.
Creating a New API Key
- Click the API key button.
- Provide a meaningful name for your API key to remember its purpose later.
- Press the Create API key button.
Successful API Key Creation

A prompt will appear, confirming the successful creation of your API key.

⚠️ Important: Make sure to copy your API key immediately, as this is the only time it will be visible. Treat your API key with the same confidentiality as your password for security purposes.
Acknowledging the API Key Copy

Once you've safely stored your API key, press the 'I've copied this access token' button to acknowledge it.

From the Partner Portal:

Selecting the API Key

Navigate through Settings > Company Settings > API key and select the specific API key you wish to disable.
Disabling the Key
- Click the Disable API key button.
- A prompt will ask for confirmation to ensure you want to disable the selected API key.
- Confirm by clicking the Disable API key button once more.
Viewing Disabled Keys

Disabled API keys can be viewed in the API keys section in the partner portal, providing a history of keys that have been used and deactivated.

From the Partner Portal:

Selecting the API Key

Navigate through Settings > Company Settings > API key and select the specific API key you wish to rename.
Renaming the Key

Update the name by entering the new name in the Name form field provided.
Saving the Updated Name

Click the Update API key button to save changes.