Публичное API ЕСП (CashDesk Service)

Версия сервиса

Самый простой метод во всём API: без параметров, без тела запроса — просто отдаёт строку с версией развёрнутого сервиса CashDesk. Используется как «пинг» — если сервис жив и отвечает, вы получите 200 и версию; если нет — таймаут или 5xx на уровне инфраструктуры (это уже вне схемы API).

Пример запроса

Пример ответа 200 · text/plain

Как использовать: добавьте вызов в свой мониторинг (Zabbix/Prometheus/cron) с проверкой кода ответа 200 и непустого тела — этого достаточно, чтобы отслеживать доступность сервиса ЕСП со стороны вашей интеграции, отдельно от статуса самой кассы.

Список вендоров

Возвращает справочник производителей/моделей касс, с которыми умеет работать ЕСП — код (используется во всех остальных методах API как значение поля vendor), человекочитаемое название и ссылку на иконку. Тело запроса не требуется — метод сделан POST в спецификации, но фактически работает как обычный «получить справочник».

Пример запроса

Пример ответа 200 · application/json

Значения поля code (enum) — расшифровка

Схема отдаёт только технический код; ниже — что каждый код означает на практике.

Как использовать: если вы строите форму подключения кассы в своём кабинете — подтягивайте этот список динамически вместо того, чтобы хардкодить вендоров у себя: ЕСП добавляет новые коды по мере подключения новых производителей, а иконки сразу дают готовый UI без своей графики.

Обновление LMCHZ (Локальный модуль Честного знака / Regime)

LMCHZ — это тот же компонент, который на странице «Файлы для скачивания» называется Regime: локальный модуль Честного знака, обязательный для маркировки, ставится один раз на кассовый ПК рядом с ЕСМ. Метод отдаёт версию и прямую ссылку на установочный файл для конкретной платформы — это ровно то, что использует автообновление Regime.

Параметр пути

Допустимые значения platform

Пример запроса

Пример ответа 200 · application/json

Это официальный пример из самой схемы API — версия там указана как 1.2.1, но на момент подготовки этой страницы на сайте актуальна Regime 2.5.1-2 (32/64-bit) — смотрите раздел «Regime» на странице файлов для скачивания. Это нормально: номер в примере из спецификации не обязан совпадать с версией на конкретном сервере — доверяйте ответу API, а не документации, если они расходятся.

Как использовать: если вы поставляете Regime в составе собственного дистрибутива — дёргайте этот метод перед установкой/обновлением клиента, чтобы не тащить с собой устаревший установщик и не хранить зеркало файлов у себя.

Проверка обновления ЕСМ

Это тот самый эндпоинт, который дёргает установленный на кассовом ПК ЕСМ, когда проверяет, не вышла ли новая версия. Вы можете вызывать его сами — например, чтобы заранее знать, что клиентам скоро потребуется обновление, или чтобы встроить проверку в собственный агент/скрипт установки.

Параметры запроса (query, объект req)

Допустимые значения os

Пример запроса

Поля ответа ESMUpdateResponse

Пример ответа 200 · application/json

Имя файла в примере выше совпадает с актуальной версией ЕСМ 1.6.3.2 на странице «Файлы для скачивания» — то есть это именно та ссылка, которую отдаёт автообновление реальным пользователям ЕСМ прямо сейчас.

Как использовать: если вы разворачиваете ЕСМ через собственный агент или MDM — вызывайте этот метод по расписанию (например, раз в сутки), сверяйте version с установленной и обновляйте автоматически при forceUpdate: true, а в остальных случаях — уведомляйте пользователя и давайте выбор.