Обзор сервиса информации о ККТ и ФН
API получения актуальной информации об арендованных кассах (ККТ) и фискальных накопителях (ФН) - состояние, наполненность, ошибки.
Дополнительный справочник
Отдельная задача после интеграции: следить за арендованными кассами. Для приема оплаты и фискализации этот раздел не нужен - путь интеграции начинается отсюда.
Сервис предназначен для получения актуальной информации об арендованной клиентом контрольно-кассовой технике (ККТ) и фискальных накопителях (ФН) через API. Доступна следующая информация:
- регистрационные данные о ККТ и ФН;
- текущее состояние ФН: процент наполненности, количество документов в ФН, срок замены ФН и т.д.;
- возможные ошибки в работе ККТ и ФН.
Базовый URL боевой среды: https://online.atol.ru
Тестовая среда: https://testonline.atol.ru - принимает те же учетные данные,
что и тестовый контур АТОЛ Онлайн v5.
Методы
| Метод | Назначение |
|---|---|
POST/GET /api/auth/v1/gettoken | Авторизация - получение токена (живет 24 часа) |
GET /api/kkt/v1/cash-registers | Информация по всем кассам группы с пагинацией |
GET /api/kkt/v1/cash-registers/{serialNumber} | Информация по одной кассе |
Типовые применения
- Мониторинг наполненности ФН - поле
fiscalStoragePercentageUseпозволяет заранее заказать замену фискального накопителя. - Контроль неотправленных документов - рост
unsentDocsсигнализирует о проблемах связи кассы с ОФД (см.networkErrorCode). - Контроль сроков -
fiscalStorageExpirationпоказывает дату замены ФН. - Дашборд парка касс - периодический опрос списка касс по коду группы.
Глоссарий
| Термин | Значение |
|---|---|
| ККТ | Контрольно-кассовая техника (касса) |
| ФН | Фискальный накопитель |
| РНМ | Регистрационный номер машины |
| ОФД | Оператор фискальных данных |
| Код группы | Идентификатор группы ККТ интернет-магазина в АТОЛ Онлайн |