Skip to main content

Authentication

To access our API endpoints, authentication is required using an API key. This key must be sent in the header of all your requests. You can recognize the key as it resembles a UUID format.

Obtaining an API Key​

To obtain your API key, follow these steps:

  1. Navigate to Settings->API Keys in your ayona account.
  2. You can either generate a new API key or use an existing one.

Once you have your API key, it must be included in the header of your API requests.

Adding the API Key to Your Requests​

To authenticate your requests, use the X-API-KEY header. Here’s an example of how to do this using curl:

curl -X GET "https://environment_base_url/api/v1/your-endpoint" \
     -H "X-API-KEY: your_api_key"