JSON API - Getting Started

1 Audience
2 Product Overview
3 Authentication
- 3.1 User 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"
    }
}

URLs

UAT	Production

UAT	Production
https://dev-api.avvio.com/api/ws_api	https://api.avvio.com/api/ws_api

SHR Group Public Documentation