Authentication - Bonx

Send a Bonx API token in the x-api-key header to authenticate each request. Each token gives access only to your team’s data.

Create a token

In your Bonx workspace, go to Settings → API tokens and create a token. It is displayed only once, so copy it immediately. Bonx retains only its prefix so that you can identify it in the list.

Settings → API tokens

Create, view and revoke your tokens. Revocation takes effect immediately. You can also find your workspace’s API URL here and copy it to BONX_API_URL.

Use a token

curl "$BONX_API_URL/sales-orders" \
  -H "x-api-key: $BONX_API_KEY"

Set BONX_API_URL and BONX_API_KEY once, as described in step 2 of the REST quickstart.

Treat your token like a password. Never expose it in client-side code. If it is compromised, revoke it immediately in Settings.