Authorization & Rate limits



For secure access to Brink Commerce APIs, we use OAuth2 as the authorization framework. This section outlines how to authenticate your application using OAuth2.


Scopes are set per client ID and can be tailored per service.

  • Price: Access to pricing information
  • Stock: Access to stock levels
  • Product: Access to product details, etc.

Key Generation

  • API keys are generated in the Merchant Portal.
  • Only User Admins have permission to generate keys.

How to Generate Keys

  1. Log in to the Merchant Portal.
  2. Navigate to the "API Keys" section.
  3. Click on "Generate New Key."
  4. Select the required scopes and confirm.

Rate Limits

Rate limits are applied to ensure fair usage and stability of the service.

Environment-based Limits

  • Limits differ depending on whether you use a production or test environment.

Serverless Infrastructure

  • Since Brink Commerce is built entirely on AWS serverless infrastructure, rate limits are set on a per-merchant basis.
  • This allows us to tailor the limits for each specific merchant need.

How to check your Rate limit

  1. Log in to the Merchant Portal.
  2. Navigate to Settings > Usage plan > Rate limits to view your current limits.