Это старая версия документа!
API системы оповещений
Общий принцип работы с оповещениями через API
Сервер QR меню хранит очередь событий за некоторый промежуток времени ( по умолчанию 5 минут ). Старые события автоматически удаляются из очереди.
Сторонний клиент может обратиться к серверу по API и получить список новых событий.
Как получить список событий
Для того, чтобы получить список событий необходимо отправить GET запрос на /api/v4/events.
Пример запроса:
GET https://ip:port/api/v4/events?hash=hash token: token
hash - это идентификатор события, благодаря которому сервер QR меню понимает, какие события клиент уже получил и какие для него являются новыми. Передается query параметром.
Для того чтобы получить все события в качестве hash передается значение none.
token - это ключ доступа к серверу QR меню. Передается внутри заголовка token.
Пример ответа:
{
"result": true,
"data": {
"updates": [
{
"hash": "0xd8833dd3",
"code": "waiter_call",
"table": 1000028,
"invoice": null,
"order": null,
"table_repr": {
"id": 1000028,
"name": "6",
"max_guests": 50
}
}
]
}
}
В ключе 'updates' содержится список из событий в хронологическом порядке.
Каждое событие представляет собой:
hash - идентификатор события
code - название события
table - идентификатор стола
invoice -
order -
table_repr - информация о столе(id, имя, максимальное кол-во гостей)
Далее сторонний клиент самостоятельно отправляет оповещения в нужный канал. Например, на электронную почту.
Как получить токен QR меню
Чтобы узнать свой токен, необходимо зайти на главную страницу QR меню, выбрать раздел «Параметры системы» - «Регистрация на сервере приложений» и скопировать значение из поля «Секретный ключ». Это и есть ваш токен.
Раздел наполняется, информация будет доступна в ближайшее время.