Skip to main content
To authenticate and access the API, you need to pass your API Key in the X-Api-Key header with each request. This API key is provided to you when you register for access to the API or through your account settings.

​
How to Use the API Key

  1. Obtain the API Key:
    After registering for the API, you’ll be provided with an API Key. Make sure to keep this key secure and do not share it publicly.
  2. Include the API Key in Your Requests:
    Every request to the API must include the X-Api-Key header, which contains your API key. This is required for all endpoints that need authentication.

​
Example Request

When making a request, add the X-Api-Key header as shown below: 
GET /api/v1/resource
Host: api.example.com
X-Api-Key: your_api_key_here

​
What Happens If You Provide an Invalid API Key?

If you provide an invalid or missing API key, the API will respond with a 401 Unauthorized status code and an error message indicating that authentication is required. 
HTTP/1.1 401 Unauthorized access Content-Type: application/json

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API key provided. Please check your key and try again."
}
⌘I