Authentication

To access the API endpoints, authentication is required through the use of an API key. This ensures that only authorized users can interact with the API services.


Authentication Method

The API uses API key-based authentication. Each request to the API must include a valid API key in the request headers. The API key serves as a unique identifier and is used to authenticate the client making the request.


How to Obtain an API Key

  • Sign Up: Register for an account on the API provider's platform.
  • Access Settings: Once registered, navigate to the settings section of your account.
  • Generate API Key: In the settings, locate the API key section and generate your API key. This key can be used to authenticate your requests.

Using the API Key

When making a request to the API, include the API key in the request headers. Below is an example using cURL to demonstrate how to set up the headers for authentication:

Request Headers
  • apikey: Your unique API key for authentication.
  • Content-Type: The content type of the request, typically application/json.
Example Request