Раздел API

Команды

Команды кассам: запрос к API агента «конвертом» и журнал всех запросов к агентам. Тот же API агента без конверта — прокси /agent/api/v1/**, см. «API агента → Через облако».

POST	`/api/v1/devices/{id}/commands`	Команда на кассу (конверт)
GET	`/api/v1/requests`	Журнал запросов к агентам

Команда на кассу (конверт)#

POST/api/v1/devices/{id}/commands

Запрос к API агента в теле {method, path, body, idempotencyKey}; ответ агента как есть. То же без конверта, с файлами и заголовками — прокси /agent/api/v1/**. Не на связи — 503, не ответила — 504 (повтор с тем же idempotencyKey не выполнит операцию дважды), выключена — 403 DEVICE_DISABLED

Параметры

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

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

Поля · CommandRequest

methodstring
шаблон: GET|POST|PUT|DELETE|PATCH
pathstringобязательное
шаблон: /api/v1/.*
от 1
bodyлюбое значение
idempotencyKeystring

JSON

{
  "method": "string",
  "path": "string",
  "body": {},
  "idempotencyKey": "string"
}

Ответ 200 application/json

Тип: object

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

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

curl

curl -X POST 'https://cloud.hw-connector.ru/api/v1/devices/42/commands' \
  -H 'X-Api-Key: hwk_…' \
  -H 'Content-Type: application/json' \
  --data '{"method":"string","path":"string","body":{},"idempotencyKey":"string"}'

Журнал запросов к агентам#

GET/api/v1/requests

Запросы через прокси /agent/api/v1/** и POST /api/v1/devices/{id}/commands: касса, метод, путь без строки запроса, код ответа, ошибка прокси, мс. Тела не хранятся; 30 дней

Параметры

Имя	Где	Тип	Описание
`deviceId`	query	integer int64	Только эта касса
`failed`	query	boolean	Только неудачные: ошибки прокси и ответы 4xx/5xx
`limit`	query	integer int32
`offset`	query	integer int32

Ответ 200 application/json

Массив · LogEntry

atstring date-time
deviceIdinteger int64
methodstring
pathstring
statusinteger int32
errorstring
msinteger int32
sourcestring

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

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

curl

curl 'https://cloud.hw-connector.ru/api/v1/requests' \
  -H 'X-Api-Key: hwk_…'