Раздел API

Кассы

Кассы аккаунта: список с отбором и страницами, карточка кассы (метрики, тревоги, события), своё название и выключатель, метрики кассы.

GET	`/api/v1/devices/{id}`	Карточка кассы
PATCH	`/api/v1/devices/{id}`	Переименовать или выключить кассу
GET	`/api/v1/devices`	Кассы аккаунта
GET	`/api/v1/devices/{id}/metrics`	Метрики кассы

Карточка кассы#

GET/api/v1/devices/{id}

Касса, на связи ли, последние значения метрик за 7 дней, открытые тревоги и последние события

Параметры

Имя	Где	Тип	Описание
`id`обязательный	path	integer int64	номер кассы из `GET /api/v1/devices`
`events`	query	integer int32	Сколько последних событий (1–500)

Ответ 200 application/json

Поля · DeviceDetail

idinteger int64
namestring
machineIdstring
agentVersionstring
osstring
createdAtstring date-time
lastSeenAtstring date-time
onlineboolean
metricsмассив MetricPoint
4 поля · MetricPoint
- atstring date-time
- namestring
- valuenumber double
- labelsstring
alertsмассив Alert
10 полей · Alert
- idinteger int64
- deviceIdinteger int64
- codestring
- subjectstring
- severitystring
- messagestring
- valuenumber double
- openedAtstring date-time
- updatedAtstring date-time
- closedAtstring date-time
eventsмассив EventView
4 поля · EventView
- atstring date-time
- typestring
- payloadobject
- deviceIdinteger int64
labelstring
disabledboolean

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

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

curl

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

Переименовать или выключить кассу#

PATCH/api/v1/devices/{id}

label — своё название (агент его не затирает), disabled — выключить: команды и прокси отвечают 403 DEVICE_DISABLED, чеки на неё не уходят

Параметры

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

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

Поля · DevicePatch

labelstring
от 0
до 200
disabledboolean

JSON

{
  "label": "string",
  "disabled": false
}

Ответ 200 application/json

Поля · DeviceView

idinteger int64
machineIdstring
namestring
agentVersionstring
osstring
lastSeenAtstring date-time
onlineboolean
labelstring
disabledboolean
openAlertsinteger int32

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

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

curl

curl -X PATCH 'https://cloud.hw-connector.ru/api/v1/devices/42' \
  -H 'X-Api-Key: hwk_…' \
  -H 'Content-Type: application/json' \
  --data '{"label":"string","disabled":false}'

Кассы аккаунта#

GET/api/v1/devices

Версия агента, на связи ли сейчас, когда была на связи, открытые тревоги. Отбор — online, q (название, номер установки), страницы — limit/offset, всего — в X-Total-Count

Параметры

Имя	Где	Тип	Описание
`online`	query	boolean	true — только на связи, false — только не на связи
`q`	query	string	Часть названия, своего названия или номера установки
`limit`	query	integer int32
`offset`	query	integer int32

Ответ 200 application/json

Массив · DeviceView

idinteger int64
machineIdstring
namestring
agentVersionstring
osstring
lastSeenAtstring date-time
onlineboolean
labelstring
disabledboolean
openAlertsinteger int32

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

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

curl

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

Метрики кассы#

GET/api/v1/devices/{id}/metrics

Значения за всё время хранения, свежие сверху; name — только эта метрика

Параметры

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

Ответ 200 application/json

Массив · MetricPoint

atstring date-time
namestring
valuenumber double
labelsstring

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

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

curl

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