Skip to content

Get started as a developer

How Bifröst Orbit fits together for developers: one sign-in, organisations, satellites with their own APIs and keys, and where each satellite's developer docs are.

Tutorial4 min read

Bifröst Orbit is a set of tools, called satellites, behind one sign-in. Orbit itself holds the people, the organisations and how they sign in. Each satellite, such as CMS Orbit or Commerce Orbit, holds its own data and has its own APIs.

As a developer you mostly work with one satellite at a time: you read Northwilds' pages from CMS Orbit, list its trips from Travel Orbit, or send its orders to an ERP from Commerce Orbit. This section covers what is the same across all of them.

How it fits together

Orbit
What it is
The platform at app.bifrostorbit.com. People sign in here once, with an email code, Microsoft or Google.
What it means for you
Orbit has no public API of its own. Your code talks to satellites.
Organisation
What it is
A company using Bifröst Orbit, such as Northwilds. Each has an id (24 hexadecimal characters) and a short name used in its sign-in address, such as northwilds.
What it means for you
Every key, token and event belongs to one organisation.
Satellites
What it is
CMS, Careers, Commerce, Travel, Booking, Presence and Insights Orbit. Each runs at its own path, such as app.bifrostorbit.com/cms.
What it means for you
Each has its own keys, roles, limits and docs. A key from one satellite never works in another.
Inside a satellite
What it is
Most satellites divide an organisation further: CMS Orbit into spaces and environments, Commerce Orbit into shops, Travel Orbit into brands, Booking Orbit into locations.
What it means for you
A key usually belongs to one of these, not to the whole organisation.
Orbit Exchange
What it is
The hub that carries events between satellites, such as commerce.order.paid.
What it means for you
You can't read from it directly. Webhooks in Orbit send its events to your systems. See Webhooks from Orbit.

An organisation's owners and admins decide in Orbit who may open which satellite. Each satellite then has its own roles, such as Developer in CMS Orbit, which decide who may create keys. See How access works.

Where each satellite's developer docs are

CMS Orbit
What you can build
Websites and apps that read pages, menus and campaigns, with SDKs for JavaScript, PHP, Swift and Kotlin
Careers Orbit
What you can build
Job lists and applications on your website, and connections to HR systems
Start here
Commerce Orbit
What you can build
Shops on your own website, checkout through your Stripe, and orders sent to your systems
Start here
Travel Orbit
What you can build
Trips and bookings on your own website
Start here
Booking Orbit
What you can build
Appointment booking on your website or through an AI assistant
Insights Orbit
What you can build
Analytics on your website and app, events from your servers, and the numbers through an API
Start here
Presence Orbit
What you can build
Reviews on your website with the review widget
Start here

What is the same everywhere

  • Keys are per satellite. Admins create them in the satellite, under API keys. Each is shown once. See API keys and organisations.
  • Addresses follow one pattern. The website APIs of CMS, Careers and Insights Orbit are on api.bifrostorbit.com; everything else is on app.bifrostorbit.com under the satellite's path. Staging has its own addresses. See API addresses.
  • Errors are JSON. REST answers carry { "error": { "code": "…", "message": "…" } }; GraphQL answers carry errors with extensions.code.
  • Too many requests answer 429, with the code rate_limited. Each satellite sets its own limits. See Rate limits.
  • Webhooks are signed with HMAC-SHA256. CMS, Careers and Commerce Orbit send them, in two header styles. See Verify webhooks from Bifröst Orbit.
  • AI assistants sign in with OAuth. Every satellite has an MCP server that an assistant connects to as a person on the team. See Sign in with Orbit.

Your first request

  1. Ask an admin of your organisation to open CMS Orbit, choose the space and environment for your website, and create a public key under API keys. It starts with cms_pk_.
  2. Read the home page:
Shell
curl -H "Authorization: Bearer cms_pk_…" \  "https://api.bifrostorbit.com/cms/v1/content?url=/"
  1. Carry on in Connect a website, or in the developer docs of the satellite you are building for.

Was this page helpful?

Read next