API keys in Osano allow you to interact with the platform programmatically—for example, to create and publish Cookie Consent configurations, upload data fields, or manage Subject Rights requests. This guide will walk you through where to find API Keys, how to create them, and what they can be used for.
Note: Only Admins can create API keys. Once generated, keys cannot be viewed again. Be sure to copy and store your key securely.
This guide covers the basics of creating and using API keys in Osano. For technical specifications, detailed endpoint documentation, and integration guidance, please refer to our developer documentation.
Creating an API Key
1. Navigate to API Keys
Go to API Keys or click the Settings Cogwheel in the top-right corner of the Osano dashboard. From there, select API Keys.
2. Click the Plus Button
In the lower-right corner of the API Keys screen, click the purple Plus (+) button to begin creating a new key.
3. Copy Your API Key
Once generated, your API key will appear in a modal window. This is the only time the key will be visible, so make sure to copy and securely store it right away.
Managing Your API Keys
-
API keys cannot be edited after creation.
-
If an API key is exposed or no longer needed, you can delete it from the API Keys screen.
-
API keys remain valid for 5 years from their creation date.
What Can the API Be Used For?
Once created, your API key can be used to interact with Osano’s Customer REST API in several ways. Most commonly, the API is used to manage Cookie Consent configurations—this includes creating new configurations, updating existing ones, and publishing changes live. You can also use the API to create, update, or delete consent rules within those configurations.
Osano's API can also support tasks related to data mapping. This includes uploading custom data fields to your data stores, deactivating or deleting data stores, and modify existing fields.
The API also allows you to work with Subject Rights requests. You can create new requests, view or update existing ones, and manage related action items—all through the API.
For full API reference material including available endpoints, request examples, and error handling, please visit our developer documentation.