Authenticating requests in this system does not follow the typical Basic Auth or OAuth format.
When your account is created, customer support will provide you an access key. This access key is very important as it will give access to your entire account. If you lose this access key, it is compromised, or has expired, please contact customer support.
When performing certain requests, which will be noted on each request's page, you will need to add a header to the request whose key will be Authorization and whose value will be generated from this page's endpoint. The generated value will be located in the payload of the response body, assuming that the request was successful.
This request will generate what is known as a session. In order to perform requests that require authorization, you must have an active session and provide the correct Guid for that session in the request's headers. Every session only lasts six hours from creation.
Controlled Errors
These are the error codes that will be returned when the hasErrors property is equal to true.
| Error Code | Error Message |
|---|---|
| error_accesskey_notfound | The access key entered was not found in our system. |
| error_accesskey_notvalid | The access key entered has either been deactivated or has expired. |