Skip to main content

Overview

The AdOr API is organized around REST. Our API accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

info

Please note that the API is still under development and the documentation and is subject to change without notice.

Authentication​

The AdOr API uses API keys to authenticate your request. Your API key has access to your database, so keep them secure. Do not share your API key in publicly accessible areas!

Requests​

All API requests will follow the same format.

BaseURL​

http://[SERVER]:[PORT]

SERVER will be given to you when the integration api is setup for your site, it will be the same server you use on the mobile client

PORT will be given to you when the integration api is setup for your site

Headers​

All requests will have at least the X-AUTH-TOKEN key with your API Key as the value. See the individual actions on the interfaces for additional headers

Body​

The request body will be a JSON object with the following properties:

  • interfaceName:
    • Datatype - String.
    • Detail - The name of the interface you want to hit.
  • returnDetailedData:
    • Datatype - Boolean.
    • Detail - Specifies whether or not you would like to have the detailed data returned.
  • data:
    • Datatype - JSON array.
    • Detail - JSON array of the data required for the selected interface. (see the individual documents)

Template:

{
  "interfaceName" : "interfaceName",
  "returnDetailedData" : true/false,
  "data": [{ 
  interface data 
  }]
}

Available Interfaces​