JSON-RPC is used for server-to-server communication. Supported specifications are JSON-RPC 1.0 and 1.1 WD.

Only POST and not GET is allowed. Requests are posted to: The X:es are replaced by your customer id.
POST is limited to 32768 bytes of content-length.
The supported encoding is UTF-8.

For the sake of brevity, only 1.1 is described.

Version - Denotes the version of JSON-RPC. If version is not stated, 1.0 is assumed. If version is stated, it must be 1.1.

Id - Is an optional request-identifier that can be used in batched or asynchronous requests to determine which call a response belongs to.
The compressed responses are supported through the use of header: Accept-Encoding: gzip. The properties can be in any order.

Named Parameters

When the parameters are named, they do not have to be in the order specified in the API. Syntax:

{"method": "Method Name", "params": {"Argument Name 1": "Argument Value 1", "Argument Name N": "Argument Value N"}, "version": "1.1", "id": "id"}

Example:

{"method": "saveSearch", "params": {"SearchPhrase": "harry potter", "ProductID": "12345"}, "version": "1.1"}

Unnamed Parameters

With unnamed parameters the order determine which parameter is which. Syntax:

{"method": "Method Name", "params": ["Argument Value 1", "Argument Value N"], "version": "1.1", "id": "id"}

Example:

{"method": "saveSearch", "params": ["harry potter", "12345"], "version": "1.1"}

Batched Requests

With batched requests it is possible to invoked multiple methods with the same call. Batched request are used to improve performance. Batched requests are done as in JSON-RPC 2.0. The batched requests can be made with both named and unnamed parameters. Syntax:

[Request1,RequestN]

Example:

[{"method": "saveSearch", "params": ["harry potter", "12345"], "version": "1.1", "id": "2"},{"method": "saveSearch", "params": ["poker book", "6789"], "version": "1.1", "id": "7"}]

The order of the returned properties is arbitrary. If id is not passes as an input argument "id": "null" is returned. If there is no error 1.1 does not return an error object, but 1.0 returns "error": null.
Syntax: Example: Syntax: Example: Syntax: Example:

All calls should ideally be made asynchronous.

If possible, transfer calls in batches.

HTTP Keep-Alive should be employed.

Compression should be enabled (via HTTP Accept-Encoding)

For testing and debugging purposes, request can be sent as GET requests. For GET requests Avail uses the POST-syntax and does not follow the specifications. GET requests are limited to about 32768 bytes (depends on what browser, proxy or web application framework you are using). Do not use GET for implementation as these are prone to change without prior warning.
GET requests allows you to test your calls using a browser. To test the calls below, replace the X:s with your customer id and append the call to: For example: Call Response Call Response Call Response Call Response Call Response