Skip to main content

Sending your key

Send it as a bearer token on every call. Keys start with ovj_live_.
Header
There are no test keys yet. Every key reads real data, which is safe because version 1 is read-only.
Never put a key in browser code or a public repository. Anyone with it can read that brand’s data.

Scopes

Every key can read its own brand without a scope. Each other kind of data has a read scope: A call without the scope it needs gets a 403 that names the missing scope. You can remove scopes from a key later, but you can’t add them. To add one, make a new key. Write scopes are coming.

Expiry and revoking

  • Keys last 30 days, 90 days or 1 year.
  • Admins get an email 14, 7 and 1 day before a key expires.
  • A revoked key stops working within a minute.
  • Keys stop working straight away if the brand’s plan ends.
Admins create, rename and revoke keys in Settings → Developers → API Keys. Other members can see the list, but can’t change it.