White Server API v2

Введение

В статье описан White Server API v2

Обратите внимание

Интеграция платная. Для ее использования требуется купить лицензию.

Авторизация

Для авторизации используется токен. Для того, чтобы получить токен необходимо:

1. Отправить запрос на интеграцию по адресу integrations@rkeeper.ru. В запросе укажите, что вы являетесь агрегатором, реквизиты, краткое описание сервиса и есть ли тестовый стенд.
2. Получить ключ авторизации для White Server API.

Передавать токен необходимо в заголовке AggregatorAuthentication.

Общее описание

Мы используем JSON-RPC. Запросы осуществляются с помощью HTTP методом POST.

Название вызываемого метода передается в теле запроса. Сервер возвращает ответ с http статус 200 Ok.

POST https://{{serverName}}/wsserverlp/api/v2/aggregators/Create
{
   "taskType": "название метода"
}

Где serverName — ws.ucs.ru 

Все json запросы должны быть в кодировке UTF-8.

Существует несколько типов запросов:

Ответ на асинхронный запрос можно получить 2 способами:

1. методом GetTaskResponse - получаете ответ по taskGuid

2. через запрос к очереди сообщений

Описание методов

Меню, стоп-лист

Заказ

Рестораны

Интеграция с Store House

Reporting (Только для агрегатора "RkReports")

Другое

Запрос к очереди сообщений

Очередь сообщений

События

События сообщают внешнему сервису об изменениях, производимых на внутренних сервисах ресторана (касса, склад).

Получение событий

Получать события можно подключившись к очереди сообщений

Пример ответа с событиями

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

Коды ошибок

Коды ошибок