Раздел API

Эмуляторы

Эмуляторы ККТ, терминала, весов и принтера для отладки без оборудования: режимы ответа («нет бумаги», отказ терминала).

PUT	`/api/v1/emulators/{number}`	Переключить режим эмулятора
GET	`/api/v1/emulators`	Эмуляторы и их режимы ответа

Переключить режим эмулятора#

PUT/api/v1/emulators/{number}

Например {"mode":"NO_PAPER"} — ККТ отвечает «нет бумаги»; {"mode":"DECLINED","once":true} — терминал откажет один раз; {"mode":"NORMAL"} — снова работает

Параметры

Имя	Где	Тип	Описание
`number`обязательный	path	integer int32	номер устройства из `GET /api/v1/devices`

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

Поля · ModeRequest

modestring
onceboolean

JSON

{
  "mode": "string",
  "once": false
}

Ответ 200 application/json

Поля · EmulatorInfo

numberinteger int32
typestring
namestring
modeState
3 поля · State
- modestring
- onceboolean
- modesмассив Mode
  3 поля · Mode
  - idstring
  - titlestring
  - descriptionstring

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

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

curl

curl -X PUT 'http://localhost:7790/api/v1/emulators/1' \
  -H 'Content-Type: application/json' \
  --data '{"mode":"string","once":false}'

curl

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

Эмуляторы и их режимы ответа#

GET/api/v1/emulators

Ответ 200 application/json

Массив · EmulatorInfo

numberinteger int32
typestring
namestring
modeState
3 поля · State
- modestring
- onceboolean
- modesмассив Mode
  3 поля · Mode
  - idstring
  - titlestring
  - descriptionstring

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

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

curl

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

curl

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