Skip to main content
Most API calls on Obiex are authenticated. API requests made without authorization will fail with status code 401: Unauthorized.

Getting Your API Credentials

  1. Create an Obiex Staging account
  2. Log in to your Obiex Staging dashboard
  3. Navigate to Settings > Developers > API Keys
  4. Click Create API Keys to generate your keys

Your Keys

If you think your keys may have been compromised, immediately generate new ones from your dashboard: Settings > API Keys > Generate new keys

Authorizing API Calls

To authorize API calls, include these headers:

Signature Generation

The signature is generated by creating an HMAC SHA256 of the following concatenated string:
The request_path must include the full path including /v1. For example: /v1/addresses/me/broker
Example in Node.js:

Complete Example

Security Best Practices

  • Never commit your API keys to Git
  • Never expose keys in client-side JavaScript
  • Store keys as environment variables
  • Rotate keys immediately if compromised