HW agent API 2.14.1
Справка OpenAPI English hw-connector.ru

Раздел API

Агент

Агент работает, его версия и питание компьютера; список устройств; язык; бренд сборки.

GET/api/v1/languageЯзык интерфейса агента
GET/api/v1/healthАгент работает
GET/api/v1/devicesУстройства рабочего места
GET/api/v1/brandingБренд сборки
GET/api/v1/branding/iconЗначок бренда

Язык интерфейса агента#

GET/api/v1/language

ru или en

Ответ 200 application/json

Тип: словарь → string

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

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

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

Агент работает#

GET/api/v1/health

Версия, время запуска, питание; клиент проверяет, что агент установлен

Ответ 200 application/json

Поля · AgentInfo
  • statusstring
  • versionstring
  • startedAtstring date-time
  • powerPower
    5 полей · Power
    • sourcestring
      значения: AC BATTERY UNKNOWN
    • batteryboolean
    • batteryPercentinteger int32
    • minutesLeftinteger int32
    • atstring date-time

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

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

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

Устройства рабочего места#

GET/api/v1/devices

Ответ 200 application/json

Массив · DeviceInfo
  • idinteger int32
  • kindstring
    значения: FISCAL_REGISTER PAYMENT_TERMINAL BARCODE_SCANNER PRINTER CASH_DRAWER CUSTOMER_DISPLAY CARD_READER CHANNEL SCALE
  • typestring
  • namestring
  • activeboolean
  • infoсловарь → любое значение

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

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

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

Бренд сборки#

GET/api/v1/branding

Название программы, производитель, поддержка, цвет; у обычной сборки — «HW agent»

Ответ 200 application/json

Поля · Info
  • productNamestring
  • vendorstring
  • supportEmailstring
  • supportUrlstring
  • accentColorstring
  • customIconboolean

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

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

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

Значок бренда#

GET/api/v1/branding/icon

PNG; у обычной сборки — 404

Ответ 200

Файл.

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

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

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