Authentication

This section explains how to use the API key to verify access rights to the user API.

Required headers

Every API request must include the following header:

Title

Value

Description

X-API-Key

your_API_key

The API key obtained in your dashboard.

If the header is not provided or is incorrect, the API will return an authentication error.

Request example

Here is a standard example of using this header in the command line:

curl -H "X-API-Key: your-api-key-here" \

"https://your-domain.com/api/v1/partner/referral-exchanges"

In this example:

  • curl — an HTTP client in the command line.

  • X-API-Key — the required header that passes your key.

  • https://your-domain.com/api/v1/partner/referral-exchanges — the endpoint being requested.

Last updated