Authentication

Required Authentication Header Parameters

To access the API, every request must be authenticated using the following headers:

• x-api-key: Your unique API key.

• tenantId: The identifier assigned to your organization (tenant).

• tenantSecret: A secret token associated with your tenant for secure access.

These credentials ensure that each request is tied to a specific tenant and is authorized to access the relevant data.

🔧 How Authentication Works

Your API key (x-api-key) authenticates your access through the API Gateway. In addition, you must provide the tenantId and tenantSecret associated with your tenant to validate your request.

If any of these values are missing or invalid, the API will respond with a 401 Unauthorized or 403 Forbidden error.

🧾 Required Headers (Example)

x-api-key: YOUR_API_KEY
tenantId: YOUR_TENANT_ID
tenantSecret: YOUR_TENANT_SECRET

⚠️ Important: Never expose your secret or API key in client-side code or public repositories.