external:qr_меню:04_оповещения_для_персонала:09_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.

Далее сторонний клиент самостоятельно отправляет оповещения в нужный канал. Например, на электронную почту.

Чтобы узнать свой токен, необходимо зайти на главную страницу QR меню, выбрать раздел «Параметры системы» - «Регистрация на сервере приложений» и скопировать значение из поля «Секретный ключ». Это и есть ваш токен.

  • external/qr_меню/04_оповещения_для_персонала/09_api.1643868971.txt.gz
  • Последнее изменение: 2022/02/03 09:16
  • alexander_troyan