Usage
Identity Access Management (IAM)
All external HTTP requests are authenticated against our internal IAM provider. Consequently, all users of our API will require that an account be created within our IAM provider, and you will use this account’s credentials to access our External Orders REST API.
Please contact your AdCellerant representative to create your account.
Auth Token
Once your account has been created, we will provide you with your username and an auth token.
REST API
Authentication
As mentioned in our Identity Access Management (IAM) section, all HTTP requests are authenticated against our internal AIM provider by validating every HTTP request against your account’s credentials. The credentials must be included in the ‘Authorization’ header of your request as defined by the ‘basic’ authorization specification RFC 7617: https://tools.ietf.org/html/rfc7617 .
For example:
If the user agent wishes to send the user-id "Aladdin" and password "open sesame," it would use the following header field:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Response Codes
200 - When the request was successful and there is a body to be returned
204 - When the request was successful but there is no body to be returned
401 - The user is unauthorized to call the API
403 - The user is authorized to call the API but does not have access to this resource.
404 - The requested resource was not found.
This should not be used for operations where multiple results are expected such as a list or search. In this case an empty array or excluding the result from the array is the desired behavior.
429 - rate limit exceeded.
500 - An unexpected error occurred.