JSON API - Getting Started
- Martin Mahony
- 1 Audience
- 2 Product Overview
- 3 Authentication
- 3.1 User Auth
- 3.2 Partner Auth
- 4 URLs
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 with the Content-Type header set to application/json.
User Auth
In most cases, userAuth 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.
{
"userAuth": {
"username": "username",
"password": "password"
}
}Partner Auth
In some cases, partnerAuth can be used to provide the site/channel with an authToken to be used for authentication.
{
"partnerAuth": {
"authToken": "UUxwaGgPSnvos3whaswTDB62JEj1xEu6zQapud7rHj988aY8r8J3JtUeYOCLWtLjCp45gz6ni4bFXp5eIgmdxuI5wJjS4F-WDZtdc27po4k"
}
}URLs