Skip to content

API keys and organisations

How organisations, satellites and their spaces, shops, brands and locations relate, which keys and tokens each satellite issues, who can create them and how to send them.

Reference4 min read

Every key in Bifröst Orbit belongs to one satellite and, inside it, to one organisation or one part of it. A key from CMS Orbit never works in Commerce Orbit, and a key for Northwilds' Oslo shop never reads the Bergen shop.

Organisations

An organisation is a company using Bifröst Orbit. Orbit keeps:

  • Its id: 24 hexadecimal characters, such as 6650c0ffee0000000000abcd. It is in the address of every screen, such as /cms/o/6650c0ffee0000000000abcd, and in every event as tenant.organisationId.
  • Its short name: lowercase letters, digits and hyphens, such as northwilds, used in its sign-in address app.bifrostorbit.com/signin/northwilds.
  • Its members: each with an Orbit role (Owner, Admin or Member) and the satellites they may open.

Satellites read who belongs to an organisation from Orbit. Owners and Admins in Orbit are admins in each satellite they open; Members start with the satellite's least access, and each satellite can give them more. There is no API for organisations or members.

Inside each satellite

CMS Orbit
An organisation holds
Spaces, each with environments such as Production and Staging, and regions
A key belongs to
One space and environment, optionally limited to some regions and languages
Careers Orbit
An organisation holds
One career site
A key belongs to
The organisation
Commerce Orbit
An organisation holds
Shops
A key belongs to
One shop
Travel Orbit
An organisation holds
Brands
A key belongs to
One brand
Booking Orbit
An organisation holds
Locations
A key belongs to
One location
Presence Orbit
An organisation holds
Locations
A key belongs to
The organisation
Insights Orbit
An organisation holds
Sites
A key belongs to
The organisation

Keys and tokens

CMS Orbit
Key or token
Public key
Starts with
cms_pk_
What it can do
Read published content
Who creates it, and where
Developer, Admin or Owner, under API keys in the space
CMS Orbit
Key or token
Secret key
Starts with
cms_sk_
What it can do
Also read drafts. Not on Production environments
Who creates it, and where
as above
CMS Orbit
Key or token
Management token
Starts with
cms_mt_
What it can do
Use the management API, optionally read-only. Lasts 1 to 365 days
Who creates it, and where
Developer, Admin or Owner, under Management tokens
CMS Orbit
Key or token
Agent key
Starts with
cms_ag_
What it can do
Connect an AI agent to the MCP server
Who creates it, and where
On the AI agents screen in the space
Careers Orbit
Key or token
Public key
Starts with
careers_pk_
What it can do
Read jobs and take applications
Who creates it, and where
Admin, under API keys
Careers Orbit
Key or token
Management token
Starts with
careers_mt_
What it can do
Use the management API, optionally read-only. Growth and Enterprise plans
Who creates it, and where
Admin, under API keys
Commerce Orbit
Key or token
Public key
Starts with
com_pk_
What it can do
Count your storefront requests
Who creates it, and where
Admin, under API keys in the shop
Commerce Orbit
Key or token
Secret key
Starts with
com_sk_
What it can do
Also read draft products. From a server only
Who creates it, and where
as above
Travel Orbit
Key or token
Public and secret keys
Starts with
trv_pk_, trv_sk_
What it can do
As in Commerce Orbit, for one brand
Who creates it, and where
Admin, under API keys in the brand
Presence Orbit
Key or token
Public and secret keys
Starts with
pre_pk_, pre_sk_
What it can do
A secret key can send review requests from your systems. Growth plan
Who creates it, and where
Admin, under API keys
Insights Orbit
Key or token
API key
Starts with
ins_live_
What it can do
Send events from your servers, read raw events through the API and GraphQL, or both. Reading needs Growth or above
Who creates it, and where
Admin, under API keys

Booking Orbit's public API needs no key: it is addressed by the location's booking name, and the location's Allowed websites decide which websites may call it from a browser.

Some things need no key at all: Travel and Commerce Orbit's catalogue reads, the Insights script and the Presence review widget.

Each satellite's developer docs describe its keys in full, such as CMS Orbit's security and access, Careers Orbit's API keys and Commerce Orbit's API keys.

Send a key

Send it in the Authorization header:

HTTP
Authorization: Bearer cms_pk_…

Every satellite also accepts X-Api-Key: …. CMS Orbit lets a public cms_pk_ key go in the address as ?apiKey=, and Careers Orbit a careers_pk_ key as ?key=, so answers can be cached close to your visitors. Never put a secret, preview or management key in an address or in a browser.

Keep keys safe

  • A key is shown once, when it is made. The satellite keeps only a hash of it, so nobody can show it to you again. Lost keys are replaced, not recovered.
  • Use one key per website or system, named after it, such as northwilds.com. Then you can replace one without touching the others.
  • Keep keys in your server's environment, not in your code.
  • Give a key an expiry date where the satellite offers one, and revoke keys you no longer use.
  • Where a satellite has Allowed websites, list the websites that may call it from a browser.

AI assistants and the Orbit app

AI assistants don't use keys. They sign in with OAuth as a person on the team, and get a token for one satellite. See Sign in with Orbit.

Was this page helpful?

Read next