AIR Concepts

Concepts

This guide defines a number of key concepts within AIR. It provides definitions for use and relates back to the objects shown in the high-level AIR Platform Overview. The child pages of this guide cover the following concepts:

These objects and concepts can be created via API or AIR dashboard.

Integration Points

The diagram below illustrates the key integration points of AIR. Each of the APIs shown in the diagram is covered in the API reference section of this portal, detailing how to integrate with them including example payloads.

AIR Integration Points

Integration Requirements

AIR's APIs implement industry standards where possible and also have several requirements that clients are required to follow when setting up a new integration. These are as follows:

  • All of the APIs are RESTful.
  • All requests should be made over SSL.
  • All request and response bodies, including errors, are encoded in JSON.
  • An empty array value will be returned if a response attribute of the type 'object' returns no value.