Authentication

An API Key is required to be sent as a part of every request.

Key Components

Site ID: Your unique site identifier.
API Key: Access credential.
Secret Key: Used for request signatures.

Basic Authentication Method

Credential Composition

Username: site_id
Password: x-api-key
Encoding: Base64

Example:

json

  "site_id": "123456",
  "x-api-key": "abcdef"

1. Base64 Encoding

Combine the site_id and x-api-key with a colon (:) separator: 123456:abcdef.
Base64 Encode: MTIzNDU2OmFiY2RlZg==.

2. Authorization Header

http

Authorization: Basic MTIzNDU2OmFiY2RlZg==

This header will be sent with your request, and the server will decode the Base64 string to retrieve the site_id and x-api-key and authenticate your request.

Troubleshooting Authentication

Common Issues

Error Code	Description	Recommended Action
401	Unauthorized	Verify credentials
403	Forbidden	Check permission levels
429	Rate Limited	Implement exponential backoff

For further assistance, contact our support team at [email protected].

Authentication ​

Key Components ​

Basic Authentication Method ​

Credential Composition ​