This guide explains how to authenticate with our API using an API key passed as a header. The API key is a unique identifier that allows you to access the API and use its features. Ensure that you keep your API key secure and do not share it publicly.
To authenticate with the API, you need to include your API key in the request headers. The header should be named x-api-key.
Below are examples of how to make an authenticated API request using different HTTP clients.
Headers
• x-api-key (required): Your API key provided to you upon registration.
• 200 OK: The request was successful.
• 401 Unauthorized: The API key is missing, invalid, or expired.
• 403 Forbidden: The API key does not have the necessary permissions for the requested resource.
• 404 Not Found: The requested resource does not exist.