Раздел API

Операции

Операции: состояние по номеру (с Prefer: wait — ожидание окончания), последние операции и события Server-Sent Events — ход операций, коды со сканеров, карты со считывателей, питание.

GET	`/api/v1/operations`	Последние операции
GET	`/api/v1/operations/{id}`	Операция
GET	`/api/v1/events`	События (Server-Sent Events)

Последние операции#

GET/api/v1/operations

Новые первыми; журнал хранит 1000 последних, в том числе после перезапуска

Параметры

Имя	Где	Тип	Описание
`limit`	query	integer int32

Ответ 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 'http://localhost:7790/api/v1/operations'

curl

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

Операция#

GET/api/v1/operations/{id}

С заголовком Prefer: wait=N ждёт окончания до N секунд

Параметры

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

Ответ 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 'http://localhost:7790/api/v1/operations/3f6c1d9e-1b2a-4c55-9e0d-6a1f0c2b7d11'

curl

curl 'https://cloud.hw-connector.ru/agent/api/v1/operations/3f6c1d9e-1b2a-4c55-9e0d-6a1f0c2b7d11' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42'

События (Server-Sent Events)#

GET/api/v1/events

event: operation, data: операция — при каждом изменении статуса или этапа. Токен можно передать в ?access_token=

Ответ 200 text/event-stream

Поток событий (Server-Sent Events).

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

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

curl

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

curl

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