Developers / REST API
Authentication
Available on the Max plan.
Every request carries the token in the Authorization header:
Authorization: Bearer orka_9fJ2xPq…
- A token gives full access to one project. There is no project ID in the URLs: the token says which project you are talking to.
- Tokens are for servers. Never ship one in a web page or a mobile app: use the Web SDK there.
- Create one token per integration, so you can revoke one without breaking the others. Revocation is immediate, give or take a minute of cache.
- The dashboard shows when and from which IP each token was last used.
- Always call the API over HTTPS: a token sent over plain HTTP can be read on the way, and a request redirected to HTTPS loses its body.
| Status | error.code |
Meaning |
|---|---|---|
| 401 | unauthorized |
No token, malformed token, unknown or revoked token. |
| 403 | plan_not_eligible |
The plan of the project does not include the API. |
| 403 | project_inactive |
The project was deleted or suspended. |