Skip to main content

Create an API key

API keys (prefixed oh_) authenticate server-to-server calls to the Hub API. Manage them under API Keys. Creating and deleting keys is limited to organization admins and owners.

Open API Keys

Create a key​

Click Create API Key and set:

  1. Name, a descriptive label such as "Warehouse integration".
  2. Scopes, the permissions the key carries. Pick only what the integration needs (see below). At least one is required.
  3. Expiration: Never, or 7, 30, 90 days, or 1 year.

Click Create Key.

The key is shown once

After creation, Orderly shows the full key in an API Key Created dialog. Copy it now. It is never displayed again, and the list only ever shows the oh_... prefix. If you lose it, delete the key and create a new one.

Scopes​

Scopes gate what a key can do. A call outside a key's scopes returns 403. They come in read/write pairs per resource:

ScopeGrants
orders:read / orders:writeView / create and update orders
shipments:read / shipments:writeView / create and update shipments
bridges:read / bridges:writeView / manage bridges
transformations:read / transformations:writeView / manage transformations
carrier-accounts:read / carrier-accounts:writeView / manage carrier accounts
rates:readRequest rate quotes
pickups:read / pickups:writeView / schedule pickups
dispatchers:read / dispatchers:writeView / manage dispatch rules
operations:read / operations:write / operations:executeView / manage / run bulk operations
webhooks:manageConfigure webhook endpoints
embed:manageCreate embed sessions and manage embed config

Use a key​

Send it as a bearer token, and select your organization with X-Organization-Id:

curl https://api.orderly-hub.com/api/v1/orders \
  -H "Authorization: Bearer oh_live_xxx" \
  -H "X-Organization-Id: <organization-uuid>"

Delete a key​

Hover a key and click the trash icon. Deletion is immediate and permanent, and any application using that key loses access at once.

Next steps​