Когда информации о текущем состоянии касс, отраженной в разделе Монитор – Система кассового сервера УКМ 5, оказывается недостаточно, можно прибегнуть к запросам через API и осуществлять контроль состояния касс с помощью внешнего сервиса мониторинга по следующей схеме:
Получение четкого списка однозначных ответов на запросы внешней системы мониторинга позволяет сформировать структурированный список проблем оперативно и в любое удобное время – независимо от текущего состояния связи касс с сервером.
Ниже приведена таблица запросов, а также форматов возможных ответов на них:
Запрос | Содержание запроса | Варианты ответа |
---|---|---|
api/v1/status/last_receipt_time Время последней активности в чеке | Дата и время последней активности в открытом чеке (открытие чека или время добавления последнего товара в чек). | 200 – Чек открыт.
|
204 – Нет открытого чека. | ||
api/v1/status/downtime Время закрытия последнего чека (время простоя кассы) | Дата и время закрытия последнего чека. | 200 – Нет открытого чека.
|
204 – Чек открыт. | ||
api/v1/status/user_role_id Получение идентификатора текущего пользователя кассы | Идентификатор текущего пользователя. | 200 – ID текущего пользователя. |
api/v1/status/ofd Количество не отправленных в ОФД чеков | Запрос наличия не отправленных в ОФД чеков. | 200 – Количество чеков. Если чеков нет, то указывается количество 0. |
api/v1/status/paper Наличие бумаги в ККТ | Запрос наличия бумаги в ККТ. | 200 – Бумага есть. |
204 – Бумаги нет. | ||
api/v1/status/vision Наличие связи с системой СуперМаг Vision | Проверка наличия связи кассы и системы СуперМаг Vision. | 200 – Связь есть. |
204 – Связи нет. | ||
api/v1/status/weight Вес с весов без открытого чека | Текущий вес на весах при закрытом чеке. | 200 – Чек закрыт.
|
204 – Чек открыт. |
Примечание. Данный сервис доступен только при использовании ККТ СП 801, СП 802, а также Атол.
Настройка
Для подключения плагина, поддерживающего отправку ответов на запросы внешней системы мониторинга, необходимо на кассовом сервере по адресу: Магазин – Типы касс, где нужно выбрать тип кассы и нажать кнопку Настройки:
В появившемся иерархическом древе необходимо найти файл mintukm.conf (applications\mintukm.conf), в котором нужно раскомментировать строку
{ include file("conf/services/monitoring.conf") }:
После этого файл нужно сохранить.
Необходимо также убедиться, что в том же иерархическом древе по адресу: applications\services присутствует файл настроек monitoring.conf:
Следует учитывать, что для успешной работы данного функционала требуется, чтобы внешняя система мониторинга:
- имела возможность ввода перечня касс для мониторинга;
- имела возможность указания IP-адреса для каждой кассы;
- поддерживала возможность работы по разработанному API;
- имела возможность отображения и обработки ответов с касс.
Примечание. Частота опроса состояний кассы не должна превышать 1 запроса в секунду.
Данный способ мониторинга подходит также для оперативного контроля состояния киосков и касс самообслуживания.