Раздел API

Киоск самообслуживания

Модуль «Киоск самообслуживания»: приём наличных купюроприёмниками CCNET и монетоприёмниками ccTalk до суммы (escrow, сдача, остановка покупателем; события cash.accepted и cash.notice), эмулятор купюроприёмника, режим киоска браузера. Нужен модуль kiosk в ключе (кроме эмулятора).

GET	`/api/v1/kiosk`	Режим киоска
PUT	`/api/v1/kiosk`	Настроить режим киоска
POST	`/api/v1/kiosk/stop`	Закрыть браузер киоска
POST	`/api/v1/kiosk/start`	Запустить браузер киоска
POST	`/api/v1/cash-acceptors/{number}/insert`	Вставить купюру в эмулятор
GET	`/api/v1/cash-acceptance`	Идущий сеанс приёма
POST	`/api/v1/cash-acceptance`	Принять наличные
POST	`/api/v1/cash-acceptance/stop`	Остановить приём
GET	`/api/v1/cash-acceptors`	Купюро- и монетоприёмники

Режим киоска#

GET/api/v1/kiosk

Настройки и запущен ли браузер киоска

Ответ 200 application/json

Поля · Status

enabledboolean
unlockedboolean

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'http://localhost:7790/api/v1/kiosk'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/kiosk' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Настроить режим киоска#

PUT/api/v1/kiosk

{"enabled":true,"url":"https://kiosk.example.ru","browser":"auto","silentPrint":true,"restartSec":3}. Включённый режим сразу запускает браузер во весь экран и поднимает его с агентом; выключенный — закрывает

Тело запроса application/json обязательное

Поля · Settings

enabledboolean

JSON

{
  "enabled": false
}

Ответ 200 application/json

Поля · Status

enabledboolean
unlockedboolean

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X PUT 'http://localhost:7790/api/v1/kiosk' \
  -H 'Content-Type: application/json' \
  --data '{"enabled":false}'

curl

curl -X PUT 'https://cloud.hw-connector.ru/agent/api/v1/kiosk' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"enabled":false}'

Закрыть браузер киоска#

POST/api/v1/kiosk/stop

Для обслуживания: до следующего запуска или перезапуска агента

Ответ 200 application/json

Поля · Status

enabledboolean
unlockedboolean

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X POST 'http://localhost:7790/api/v1/kiosk/stop'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/kiosk/stop' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Запустить браузер киоска#

POST/api/v1/kiosk/start

Ответ 200 application/json

Поля · Status

enabledboolean
unlockedboolean

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X POST 'http://localhost:7790/api/v1/kiosk/start'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/kiosk/start' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Вставить купюру в эмулятор#

POST/api/v1/cash-acceptors/{number}/insert

Только эмулятор купюроприёмника: купюра примется в идущем сеансе

Параметры

Имя	Где	Тип	Описание
`number`обязательный	path	integer int32

Тело запроса application/json обязательное

Поля · Insert

valuenumber

JSON

{
  "value": 1.5
}

Ответ 200

Без тела.

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X POST 'http://localhost:7790/api/v1/cash-acceptors/1/insert' \
  -H 'Content-Type: application/json' \
  --data '{"value":1.5}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/cash-acceptors/1/insert' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"value":1.5}'

Идущий сеанс приёма#

GET/api/v1/cash-acceptance

Сколько уже принято; 404 — сеанса нет

Ответ 200 application/json

Поля · Result

validboolean
errorsмассив Issue
8 полей · Issue
- codestring
- severitystring
  значения: ERROR WARNING
- atstring date-time
- registerinteger int32
- terminalinteger int32
- fdinteger int64
- amountinteger int64
- messagestring
warningsмассив Issue
8 полей · Issue
- codestring
- severitystring
  значения: ERROR WARNING
- atstring date-time
- registerinteger int32
- terminalinteger int32
- fdinteger int64
- amountinteger int64
- messagestring

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'http://localhost:7790/api/v1/cash-acceptance'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/cash-acceptance' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Принять наличные#

POST/api/v1/cash-acceptance

Операция

Операция cash-acceptance: включает приёмники и ждёт, пока внесут amount (пусто — пока не остановят). Каждая купюра — событие cash.accepted с набранной суммой, отбраковка и сбои — cash.notice. result: received — принято, change — сверх суммы (сдачу выдаёт программа), status — COMPLETED, STOPPED, TIMEOUT или ERROR. Принятые деньги всегда в result, даже если приёмник отказал посреди сеанса. Без ключа модуля — 402 LICENSE_REQUIRED (кроме эмулятора)

Параметры

Имя	Где	Тип	Описание
`Idempotency-Key`обязательный	header	string
`Prefer`	header	string

Тело запроса application/json

Поля · Request

originstring
firstAtstring date-time
lastAtstring date-time
requestsinteger int32

JSON

{
  "origin": "string",
  "firstAt": "2026-11-01T19:00:00+03:00",
  "lastAt": "2026-11-01T19:00:00+03:00",
  "requests": 1
}

Ответ 200 application/json

Поля · Operation

idstring uuid
typestring
idempotencyKeystring
resourcesмассив string
statusstring
значения: QUEUED RUNNING SUCCEEDED FAILED UNKNOWN
stagestring
createdAtstring date-time
startedAtstring date-time
finishedAtstring date-time
resultлюбое значение
errorOperationError
3 поля · OperationError
- codestring
- messagestring
- detailsлюбое значение
warningsмассив string

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X POST 'http://localhost:7790/api/v1/cash-acceptance' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"origin":"string","firstAt":"2026-11-01T19:00:00+03:00","lastAt":"2026-11-01T19:00:00+03:00","requests":1}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/cash-acceptance' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Prefer: wait=30' \
  -H 'Content-Type: application/json' \
  --data '{"origin":"string","firstAt":"2026-11-01T19:00:00+03:00","lastAt":"2026-11-01T19:00:00+03:00","requests":1}'

Остановить приём#

POST/api/v1/cash-acceptance/stop

Покупатель нажал «Готово» или «Отмена»: приёмники выключаются, операция заканчивается со статусом STOPPED и принятой суммой

Ответ 200 application/json

Поля · Stopped

stoppedboolean

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl -X POST 'http://localhost:7790/api/v1/cash-acceptance/stop'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/cash-acceptance/stop' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

Купюро- и монетоприёмники#

GET/api/v1/cash-acceptors

Номиналы и состояние; session — идущий сеанс приёма

Ответ 200 application/json

Поля · AcceptorList

licensedboolean
acceptorsмассив AcceptorInfo
7 полей · AcceptorInfo
- numberinteger int32
- namestring
- typestring
- kindstring
- activeboolean
- denominationsмассив number
- infoсловарь → любое значение
sessionResult
3 поля · Result
- validboolean
- errorsмассив Issue
  8 полей · Issue
  - codestring
  - severitystring
    значения: ERROR WARNING
  - atstring date-time
  - registerinteger int32
  - terminalinteger int32
  - fdinteger int64
  - amountinteger int64
  - messagestring
- warningsмассив Issue
  8 полей · Issue
  - codestring
  - severitystring
    значения: ERROR WARNING
  - atstring date-time
  - registerinteger int32
  - terminalinteger int32
  - fdinteger int64
  - amountinteger int64
  - messagestring

Ошибки — problem+json с полем code, см. коды ошибок.

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

curl

curl 'http://localhost:7790/api/v1/cash-acceptors'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/cash-acceptors' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'