There are 2 versions of the API:

  1. API v2 — recommended API version
  2. API v1 — not supported since 2020

The table of correspondence between White Server API and agent versions is presented below:

ProductVersionWhite Server Agent V1White Server Agent V2
r_keeper 7v1+
v2++
StoreHouse 5v1+
v2++
StoreHouse 4v1+
v2+

Requests to White Server

There are 2 types of requests in WhiteServer:

  • synchronous — the response is returned immediately
  • asynchronous — the request is sent to the restaurant, and the response is returned to the address specified in the request in the callback field.

You can read more about synchronous and asynchronous requests in the article synchronous and asynchronous requests.
If you plan to use asynchronous requests with a returned callback, you need to configure an external service accessible to White Server and specify its address in the callback field in the request.