Audience
This document is intended for distribution channels and their development teams that wish to connect to the Allora IBE.
The reader should be familiar with web services and JSON.
Product Overview
Authentication
Partner sites/channels will be provided with credentials to authenticate requests to the API. Only information for properties enabled for your API credentials will be returned in response.
All requests are expected to be sent as HTTP POST requests with the content-type header set to application/json.
User Auth
In most cases, user auth will be used, the credentials supplied will need to be explicitly set in the userAuth section of the request and access will only be granted to sites this user is authorized to have access to. When authenticating via the userAuth method, siteID or siteIDList must be specified for the API to determine which site(s) the request relates to.
{
"userAuth": {
"username": "username",
"password": "password"
}
}
Partner Auth
In some cases, partner auth can be used to provide the site/channel with an authToken to be used for authentication. When authenticating via the partnerAuth method, siteID/siteIDList may be specified, if not, the response will contain information for all sites the authToken is configured to allow access to. For some operations, the siteID may still be mandatory, in this case it will be mentioned in the instruction page for that operation.
{
"partnerAuth": {
"authToken": "UUxwaGgPSnvos3whaswTDB62JEj1xEu6zQapud7rHj988aY8r8J3JtUeYOCLWtLjCp45gz6ni4bFXp5eIgmdxuI5wJjS4F-WDZtdc27po4k"
}
}
URLs
UAT: https://dev-api.avvio.com/api/ws_api
Production: https://api.avvio.com/api/ws_api