Access Keys

Access Keys are authentication tokens used to securely access your project’s APIs. They allow your applications or services to interact with the platform without exposing sensitive user credentials.

Key Benefits

• Project Access: each access key belongs to one project and can call that project’s integration APIs. Every key has the same access: there are no per-key permission levels.
• Environment Isolation: Use a separate project for each environment (e.g., development, staging, production), each with its own keys, to prevent accidental cross-environment interactions.
• Easy Integration: Include access keys in your requests to authenticate seamlessly with our APIs.

Best Practices

• Keep Keys Secret: Never expose your keys in client-side code or public repositories.
• One Key per Service: Create a separate key for each service or script, so you can switch one off without affecting the others.
• Rotate Regularly: Keys cannot be regenerated. To rotate a key, create a new one, switch your services over to it, then disable and delete the old one.
• Act Fast on a Leak: If a key may have been exposed, disable it immediately, then replace it.

Common Use Cases

• Connecting backend services to your content pipeline.
• Automating content creation or updates via scripts or CI/CD pipelines.

How to Create an Access Key

To generate an access key for your project, follow these steps:

1. Log in to your Customer Dashboard Start by signing in to your account via the Customer Dashboard.

2. Navigate to the “Access Keys” Section In the sidebar menu, locate and click on “Access Keys”, then select your project. The page lists that project’s keys.

3. Click “Create Access Key” At the top of the page, click the “Create Access Key” button. A dialog will appear where you can configure the new key.

4. Configure the Key

   • Optionally, name your key for easy identification (e.g., “Backend”, “CI pipeline”).

5. Save and Copy Your Key Once the key is created, the dialog shows its public key and secret key. Copy the secret key and store it in a secure location. For security reasons, this is the only time the secret key will be visible.

Managing Access Keys

The Access Keys page shows each key’s name, public key, status, creation date and last use. From the menu next to a key you can:

• Disable it: requests made with the key are rejected until you enable it again.
• Enable it: a disabled key starts working again.
• Delete it: the key is removed permanently. This cannot be undone.