White Server API v1
Устаревшая версия API, не поддерживается. Актуальная версия API.
1 Общее описание
Все xml запросы должны быть в кодировке UTF-8. Существует несколько типов запросов:
Тип запроса | Как работает? | Отличие | Пример команды |
---|---|---|---|
Cинхронный | В HTTP Response приходит результат команды | Для выполнения команды не требуются обращения в ресторан и команда выполняется сразу | get_objects, get_object_properties |
Асинхронный | 1) В HTTP Response приходит guid команды (task guid). 2) Запрос отправляется в ресторан. 3) После выполнения результат приходит на WS. 4) Затем результат отправляется внешнему сервису по адресу, который был указан в поле callback исходного запроса, в ответе содержится task guid, чтобы вызывающий сервер знал, ответ на какую команду пришел (см. шаг 1). | Запрос отправляется в ресторан, и это увеличивает время ответа. В callback может придти ошибка подключения к ресторану. | sh_get_currencies, exec_rk7call |
2 Авторизация агрегаторов
3 Список команд
Запрос | Описание |
---|---|
cancel_order_delivery | Отмена запроса на доставку |
exec_crmcall | Выполнить произвольную команду CRM ??? |
exec_rk7call | Выполнить произвольную команду интерфейса |
get_connected_systems | Получение информации о подключенных к агенту системах и проверка их доступности |
get_menu | Получить меню |
get_objectinfo | Получение информации по ресторану |
get_object_properties | Получить ссылку на картинки меню |
get_objects | Получить список объектов |
get_order | Получить заказ по QR |
get_state | Получить статус по заказам |
get_tasklist | Получить список задач |
get_task_response | Получение ответа по задаче |
new_order_delivery | Создание запроса на доставку |
pay_order | Оплата заказа |
resend_callback | Повторная отправка колбэков |
rssql | MS SQL Server (RK ReportServer) |
sh_del_doc_dashing_report | Удаление расходной накладной |
sh_del_doc_receiving_report | Удаление приходной накладной |
sh_doc_dashing_report | Создать расходную накладную |
sh_doc_invent | Документ инвентаризации |
sh_doc_product_return | Создать документ возврата товара |
sh_doc_receiving_report | Создать приходную накладную |
sh_get_classifiers | Список классификаторов объектов |
sh_get_classifiervals | Список значений классификаторов объектов |
sh_get_corrs | Получить список корреспондентов |
sh_get_currencies | Получение валют |
sh_get_doc_dashing_report | Просмотр расходной накладной |
sh_get_doc_receiving_report | Просмотр приходной накладной |
sh_get_goodgroups | Получить список товарных групп |
sh_get_goods | Получить список товаров |
sh_get_goods_ctg | Получить категории товаров |
sh_get_munits | Получить список единиц измерения с группами |
sh_get_staff | Получить список сотрудников |
sh_get_stores | Получить список складов |
sh_new_good_group | Создание товарных групп |
sh_new_good | Создать товар |
sh_rep_bill_of_balance | Отчеты. Ведомость остатков |
4 События агентов
5 Примеры реализации запросов
Пример отправки команды через HTTP запрос (cURL)