Раздел API

Мониторинг

Состояние парка: сводка аккаунта одним запросом, тревоги (ФН, ОФД, смена, ККТ не отвечает, касса пропала), события касс и последние значения метрик по всем кассам.

GET	`/api/v1/summary`	Сводка аккаунта
GET	`/api/v1/metrics/latest`	Последние значения метрики по кассам
GET	`/api/v1/events`	События касс
GET	`/api/v1/alerts`	Тревоги касс

Сводка аккаунта#

GET/api/v1/summary

Сколько касс на связи, версии агента, открытые тревоги по кодам, запросы к агентам за сутки — состояние парка одним запросом

Ответ 200 application/json

Поля · Summary

devicesсловарь → integer int64
agentVersionsсловарь → integer int64
alertsсловарь → любое значение
requestsсловарь → integer int64

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

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

curl

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

Последние значения метрики по кассам#

GET/api/v1/metrics/latest

Например name=fn.days_left — сколько дней осталось ФН на каждой кассе аккаунта; значение за последние 7 дней, по одному на кассу и набор меток

Параметры

Имя	Где	Тип	Описание
`name`обязательный	query	string	Имя метрики: fn.days_left, ofd.not_sent, shift.open, register.ok, agent.up…
`deviceId`	query	integer int64	Только эта касса

Ответ 200 application/json

Массив · LatestMetric

deviceIdinteger int64
atstring date-time
namestring
valuenumber double
labelsstring

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

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

curl

curl 'https://cloud.hw-connector.ru/api/v1/metrics/latest?name=fn.days_left' \
  -H 'X-Api-Key: hwk_…'

События касс#

GET/api/v1/events

Неудачные операции, принтеры, питание, ККТ не отвечает — свежие сверху; всего — в X-Total-Count

Параметры

Имя	Где	Тип	Описание
`deviceId`	query	integer int64	Только эта касса
`type`	query	string	Тип события: operation.failed, printer, power, register.unavailable…
`since`	query	string date-time	Не раньше этого времени (ISO 8601)
`limit`	query	integer int32
`offset`	query	integer int32

Ответ 200 application/json

Массив · EventView

atstring date-time
typestring
payloadobject
deviceIdinteger int64

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

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

curl

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

Тревоги касс#

GET/api/v1/alerts

FN_EXPIRING (ФН ≤ 30 дн., ≤ 7 — критично), OFD_BACKLOG, SHIFT_EXPIRED, REGISTER_UNAVAILABLE, DEVICE_OFFLINE. Открываются и закрываются сами; open=false — и закрытые

Параметры

Имя	Где	Тип	Описание
`open`	query	boolean
`deviceId`	query	integer int64
`code`	query	string	Только этот код: FN_EXPIRING, OFD_BACKLOG…
`severity`	query	string	WARNING или CRITICAL

Ответ 200 application/json

Массив · Alert

idinteger int64
deviceIdinteger int64
codestring
subjectstring
severitystring
messagestring
valuenumber double
openedAtstring date-time
updatedAtstring date-time
closedAtstring date-time

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

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

curl

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