API Documentation
Introduction
API Documentation
Introduction
Understand how to use the Apriora API
Base URL
The Apriora API is built on REST principles, and only requests using the HTTPS protocol are supported.
All request should be made to the following base URL:
Authentication
In order to authenticate you need an API-Key obtained from your dashboard.
Add the following header to all your requests:
Response codes
Apriora uses the standard HTTP code to indicate the success or failure of an API request.
200 Codes in the indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with the Apriora servers.
| Status | Description |
|---|---|
200 | Successful request |
400 | Invalid Parameters |
401 | The API key used was invalid. |
404 | The resource was not found. |
5xx | Indicates an error with the Apriora servers. |