View Categories

Steps for create API KEY

Follow below steps to creating new API KEY

  1. Log in to the Nexbro Admin Panel.
  2. Navigate to API Keys under the Integrations section.
  3. Click Create New API Key.
  4. Enter a descriptive Name for the API key.
  5. (Optional) Configure IP Whitelisting to restrict access to specific IP addresses.
  6. Set Rate Limits if needed to control request frequency.
  7. Click Save. The system will generate the API Key.
  8. Copy or Download API KEY for future use.

Using the API Key in Requests

Include the API Key in the request headers as follows:

X-API-KEY: <YOUR_API_KEY>

Example in cURL:

curl --location 'https://your-nexbro-domain.com/admin/api/nexbro/v1/extensions' 
--header 'Accept: application/json' 
--header 'X-API-KEY: sk_live_tTD9RQfK2q2pdsqIEIca53y3gkGll1brp0mWLMeG6vnmrDHYZ1ThOupslBHg'

Rate Limiting Headers

The API may return the following headers to indicate rate limiting:

  • X-RateLimit-Limit – Maximum number of requests allowed per day.
  • X-RateLimit-Remaining – Number of requests remaining in the current day.
  • X-RateLimit-Reset – Time (in seconds) until the rate limit resets.

API KEY related error response

The following response codes are returned by the API.

HTTP CODESummaryDescription
401HTTP_UNAUTHORIZEDReturned when no API key is provided in the request headers (X-API-KEY) or the key in invalid or expired.
403HTTP_FORBIDDENReturned when the request originates from an IP address that is not whitelisted for the API key.

What are your Feelings