API-Key

🚧

This API-key authentication method will be deprecated by the end of 2026. Plan to migrate to the advanced token based authentication method.

Overview

❗️

Important:

IP whitelisting is a must for partners onboarding on API Key Authentication

• Every request must include an Authorization Header with your siteid and apikey, separated by a colon. This must match the siteid and apikey in the request body. The Authorization header is mandatory for all API requests
• Authorization header format:

Authorization: <Site-ID>:<API-Key>

• Authorization header example:

Authorization: 123456:00000000-0000-0000-0000-000000000000

• Your account manager will share the API Key with you.

Example request

curl --location --request POST 'https://{BASE_URL}/{path}' \
--header 'Authorization: 123456:00000000-0000-0000-0000-000000000000' \
--header 'Content-Type: application/json' \
--data-raw '{}'

• A successful Authorization Header returns a response with the structure described in the API references.

Sample failed response (due to Authorization Header)

1. Missing Headers:

{
    "error": {
        "id": 108,
        "message": "Site ID or API key is invalid or missing in the header"
    }
}

2. Incorrect Site ID:

{
    "error": {
        "id": 101,
        "message": "Site ID 123456 is invalid"
    }
}

3. Incorrect API Key:

{
    "error": {
        "id": 102,
        "message": "API key *****d11eb is invalid"
    }
}