White Server API v2

Introduction

The article describes White Server API v2

Please note

Integration is paid. To use it, you need to buy a license.

Authorization

A token is used for authorization. To obtain a token, it is necessary to:

1. Send a request for integration to integrations@rkeeper.ru. In your request, please indicate that you are an aggregator, your details, a brief description of the service, and whether there is a test stand.
2. Get an authorization key for the White Server API.

The token must be passed in the AggregatorAuthentication header.

General description

We use JSON-RPC. Requests are made using HTTP POST method.

The name of the called method is passed in the request body. The server returns a response with http status 200 Ok.

POST https://{{serverName}}/wsserverlp/api/v2/aggregators/Create
{
   "taskType": "method name"
}

where serverName — ws.ucs.ru 

All json requests must be in UTF-8 encoding.

There are several types of requests:

There are 2 ways to get a response to an asynchronous request:

1. GetTaskResponse method — get the response by taskGuid

2. via a request to the message queue

Description of methods

Menu, out-of-stock list

Order

Restaurants

Integration with Store House

Reporting (Only for the "RkReports" aggregator)

Other

Message queue request

Message queue

Events

Events inform the external service about changes made to the restaurant's internal services (cash register, warehouse).

Receiving events

You can receive events by connecting to the message queue.

Example of response with events

{
  "eventResponse": {
  ----------agent event response json---------
  },
  "responseCommon": {
    "taskType": "Event",
    "objectId": int
  },
  "error": {
      ----------error response json---------
  }
}

Error codes

Error codes