How to generate and manage API keys

Generate and manage secure API keys with read-only or full-access rights. Set expiration, control usage, and access API documentation.

Administrators with sufficient rights can create and manage API tokens to integrate third-party systems or automate operations. Tokens can be scoped with either read-only or full-access permissions and configured with a custom validity period (minimum of 6 months).

API key capabilities

When creating an API key, you can:

• Set the access level (read-only or full-access)

• Define a validity period (minimum 6 months)

• Assign a name and optional description

• Enable or disable the key at any time

• Rename or renew the key without changing the token

Important: The API key is displayed only once during creation. Copy and store it securely. If lost, you must delete the key and create a new one.

Access to API base URL and documentation

After you generate a key, the interface displays:

• The key

• The base API URL

• A link to the developer documentation (usage, endpoints, examples)

Generate an API key

1. Navigate to API key management
   Go to Admin console > Settings > API keys
2. Click add API key
3. Configure the key
   1. Name: Enter a unique name (e.g., CRM integration)
   2. Expiration: Set the expiration date (minimum 6 months)
   3. Profile: Choose:
      1. Read-only: Can only retrieve data
      2. Full-access: Can retrieve, create, update, and delete
   4. Description (optional): Add a brief note for context

1. Generate and store the key
   1. Click Generate
   2. Copy the key when it appears
   3. Store it securely (e.g., in a password manager)
   4. You will not be able to view the key again

Manage existing API keys

To manage an API key, return to Admin console > Settings > API keys, and select the token you want to update.