Sending your key

Send your API key as a bearer token on every request:
Requests are only accepted over HTTPS. A request with a missing or invalid key returns 401.

Creating a key

Create and revoke keys in the Cerium dashboard. Choose the scopes the key needs when you create it.

Scopes

A scope limits what a key can do. A call that needs a scope the key does not hold returns 403.
Give each integration its own key with the fewest scopes it needs. A service that only displays conversations needs conversations:read and nothing else.

Keeping keys safe

Never ship a key in a mobile app, a browser bundle or a public repository. Anyone who holds the key can act as your company.
Read the key from an environment variable or a secrets manager. Do not write it into source code.
Create a new key, deploy it, confirm traffic has moved, then revoke the old one.
Revoke it in the dashboard straight away and create a replacement.

Errors