How to authenticate with the Optimizely Data Platform (ODP) APIs.
Public versus Private API Keys
Optimizely Data Platform (ODP) provides two forms of authentication: Public and Private.
Note
Keys are scoped at the account level.
If you have multiple accounts within ODP, the data within one account is not accessible to the others, you must utilize the appropriate API key.
- Public API Keys (sometimes referred to as a Tracker ID) are used for most API calls that send data to ODP and for a limited number of API calls that request data from ODP and may be exposed publicly on the Internet.
- Private API Keys can be used for querying data from ODP for backend services and integrations.
Important
When you revoke a private API key, your existing key is available for 12 hours as a grace period to ease any transitions.
Locate API Keys
To view your API Keys, go to Account Settings > APIs. The screen displays a table of all available APIs:
| Table Column | Description |
|---|---|
| API Name | The name of the API |
| Usage Plan | The usage plan for the API will be Default, No Access or the name of a Custom Plan/Package that your company has access to. |
| Limits | The limits placed upon the API including rate limits and quotas (if applicable). |
Note
Public API Key and Tracker ID are synonymous within ODP.
Using API Keys
To use your API key, include it in the headers of your REST API request. For example:
curl -iX GET \
'https://api.zaius.com/v3/[email protected]' \
-H 'x-api-key: example.apiKey'