API keys (machines)
Your server authenticates every request with an API key in the X-Api-Key
header:
curl https://api.orbitum.io/api/v1/cex/orders \
-H "X-Api-Key: <your-key>"
Header-based keys keep secrets out of URLs, logs, and browser history. Get a key by following Onboarding → Generate an API key.
How keys are validated
- Fail-closed. A missing or empty
X-Api-Key, or an unknown / revoked / expired key, all return a uniform401 CEX_UNAUTHORIZED(no distinction, to avoid leaking which keys exist). - A suspended partner returns
403 CEX_PARTNER_SUSPENDED. - Keys may be IP-restricted. In production, requests must originate from an allow-listed address; others are rejected. Ask Orbitum to configure your allowed IPs.
- Orbitum stores only a hash of your key (HMAC), never the secret.
Good practice
Key handling
- Never log keys; never commit them; never embed them in client-side code.
- Use separate keys per environment (sandbox vs production).
- Rotate on a schedule and immediately on suspected exposure.
- Store in environment variables or a secrets manager.
Key lifecycle — issue, rotate, revoke, limits, and secret handling — is covered in Managing your API key.