Introduction and Abbreviations

  • White Server — White Server
  • Agent, WS Agent, WSA — White Server Agent

White Server is a cloud service that allows a restaurant to work with external integrations using agents. White Server is the entry point to the restaurant via a public API.

The required r_keeper version is 7.6.0 or higher.

For the service to function properly, licenses are required.
Integration via White Server API requires 4 types of licenses.

Instructions for setting up and installing WSA are described in a separate article.

Workflow



A third-party service implements one of the business scenarios (booking, payment, delivery, etc.). The sequence for performing one of the steps of the business scenario is represented below:

  • A third-party service sends an http-request to WhiteServer (e.g. create an order at restaurant YYY).
  • WhiteServer checks the external service's access to a specific restaurant and passes the task to a specific restaurant (e.g. create an order).
  • WSAgent running at the restaurant forwards the request at the restaurant to r_keeper7 (XML Interface) or store_house (OLE API).
  • After r_keeper responds, WSAgent passes the response to WhiteServer.
  • WhiteServer sends the response to the external service that created the request via http.