Loyalty Online API Implementation

API implementation principles

A web service implementing the Loyalty Online API is deployed at the partner's host and must be integrated with partner's CRM system according to Koshelek Developers documentation. For messaging, the standard RESTful model is used, the data is transmitted in JSON format via the HTTPS protocol:

As the web service implementing the API is deployed at partner's host, the following data must be presented to Koshelek:

API Requests Authorization

The HTTPS protocol is used. HTTP Basic Authentication (RFC 7617) mechanism should be used for API requests authorization. Credentials for authorization are transferred at the Authorization HTTP header.

Encoding Requirements

Both API requests and responses should use UTF-8 encoding.

API Responses Structure

1. Headers

Answers from the partner's side must contain the following header:

Content-Type: application/json; charset=utf-8;

2. HTTP Codes

Answers from the partner's side must use the following HTTP codes:

3. Body

The response body from the partner must comply with the response requirements specified in the description of the corresponding request.

4. Errors

In case of error the partner's side must return a JSON object containing the error code and description.

Response example:

HTTP/1.1 422 Unprocessable Entity
<headers>

{
 "code": "123",
 "description": "DBMS server unavailable"
}