.svg){kind=icon}
Overview
The Marketplace Platform allows users with the proper permissions to generate and manage their own API keys. This self-serve feature is essential for building custom integrations, pulling reporting data, or automating tasks.
This guide explains who can create keys and how to manage them securely.
Who Can Manage API Keys?
Access to the API Keys section is based on user roles and permissions.
- Administrators have API access enabled by default.
- Marketplace Managers must be granted API access by an Administrator.
- Only users with API access will see the Account > API Keys option in the left-hand menu.
Managing Your API Keys
You can generate, edit, and revoke keys directly from your account.
Generating An API Key
Navigate to
Account > API Keys
from the main menu.Click the
API Key
button in the top left corner.Give your key a descriptive
Name
(e.g., "Internal Reporting Dashboard") to identify its purpose.Grant permissions for the key. You can select
All permissions
or choose specific sections like Reporting
.After securely copying the key, click
Done
.Heads Up!
A window will appear displaying your new API key. For security reasons, this is the only time the full key will ever be shown. You must copy the key and store it in a secure location now. Once you close this window, you will not be able to retrieve it.
Editing An Existing API Key
You can update the name or permissions of a key at any time.
From the
Manage API Keys
page, find the key you wish to edit and click the menu on the right.
Select
Edit
from the options.Make your changes and click
Update API Key
when done.Revoking An Existing API Key
If a key is no longer needed or has been compromised, an Administrator or a Marketplace Manager with API access can permanently revoke it.
Heads Up!
Revoking a key is a permanent action that cannot be undone. The key will be disabled immediately and any integration using it will stop working.
On the
Manage API Keys
page, find the key you want to remove.Click the
menu on the right side of its row and select
Revoke
.A confirmation window will appear.
Click
Revoke API Key
to permanently disable it.
