Consumer Creation

Register an app and get your API key.

Register Your Application

Before your application can make authenticated API calls, you need to register it as a Consumer. This gives you a consumer_key and consumer_secret that identify your app.

How to Register

  1. Make sure you are logged in to the portal.
  2. Go to Get API Key.
  3. Fill in the registration form:
    • App Name — a human-readable name for your application
    • App Type — web, mobile, or other
    • Description — what your application does
    • Developer Email — your contact email
    • Redirect URL — the OAuth callback URL (required for OAuth2 flows)
  4. Submit the form. You will receive your consumer_key and consumer_secret.

Important Notes

  • Keep your consumer_secret safe. Do not expose it in client-side code or public repositories.
  • Your consumer may need to be approved by an administrator before it can be used, depending on the OBP instance configuration.
  • You can view and manage your registered consumers in My Consumers.

Using Your Consumer Key

The consumer key is used during the authentication process. For Direct Login, it is included in the Authorization header:

Authorization: DirectLogin username="YOUR_USERNAME",
  password="YOUR_PASSWORD",
  consumer_key="YOUR_CONSUMER_KEY"

For OAuth2 flows, the consumer key is the client_id and the consumer secret is the client_secret.

See the Consumer endpoints in the API Explorer for programmatic consumer management.

Next Steps