Protocol

The API are based on HTTP REST protocol. The data format is JSON exclusively.

Each request must be authenticated with an api key and an optional group key.

Parameters

Parameters may be specified in the URL for both GET and POST requests and in the request body for POST request.

The format of the body can either be JSON or URL Formdata.

JSON Example

POST /path HTTP/1.1
Accept: */*
User-Agent: Ruby
Content-Type: application/json
Host: localhost:8000
Content-Length: 36

{"foo":"bar","nested":{"foo":"bar"}}

URL Formdata example

POST /path HTTP/1.1
Host: localhost:8000
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept: */*
User-Agent: Ruby
Content-Type: application/json
Content-Length: 27

foo=bar&nested%5Bfoo%5D=bar