Skip to main content

Auth

To interact with our API, all requests must be authenticated. This ensures that the API recognizes you and authorizes access to its resources.

Authorization Methods​

Our API supports two types of authorization, both using Bearer tokens:

  1. API Key Authorization (retrieved from Settings > API Keys).
  2. Pre-Generated Token Authorization (specific to some dedicated endpoints, with details provided in their respective documentation).

1. API Key Authorization​

API keys are used to authenticate requests to the API. They can be obtained from the Settings > API Keys section in your dashboard.

  • Usage: Attach the API key to your request headers as follows:

    Authorization: Bearer <your-api-key>

2. Pre-Generated Token Authorization​

Certain endpoints require a pre-generated token instead of an API key. The process for obtaining and using this token is specified in each endpoint’s documentation.

  • Usage: The generated token should also be passed as a Bearer token in the request headers:

    Authorization: Bearer <generated-token>

  • Token Retrieval:

    • The process of generating and retrieving the token will be provided in the documentation of the endpoints that require them.

Security Best Practices​

  • Always use HTTPS when making API requests.
  • Regularly rotate API keys to enhance security.

For more details, refer to the individual endpoint documentation under the API Reference section.