Раздел API

Дисплей покупателя

Строки на дисплее покупателя и QR-код на дисплее QR-кодов или втором мониторе.

GET	`/api/v1/displays/{id}`	Что показано на дисплее
POST	`/api/v1/displays/{id}`	Показать строки на дисплее покупателя
POST	`/api/v1/displays/{id}/qr`	Показать QR-код на дисплее покупателя

Что показано на дисплее#

GET/api/v1/displays/{id}

Для дисплея на втором мониторе: страница берёт отсюда строки при открытии

Параметры

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

Ответ 200 application/json

Тип: словарь → любое значение

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

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

curl

curl 'http://localhost:7790/api/v1/displays/1'

curl

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

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

POST/api/v1/displays/{id}

VFD — обычно 2 строки по 20 символов; второй монитор — до 10 строк крупно. Сразу, не операция

Параметры

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

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

Поля · DisplayRequest

linesмассив stringобязательное
от 0
до 20

JSON

{
  "lines": [
    "string"
  ]
}

Ответ 200

Без тела.

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/displays/1' \
  -H 'Content-Type: application/json' \
  --data '{"lines":["string"]}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/displays/1' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"lines":["string"]}'

Показать QR-код на дисплее покупателя#

POST/api/v1/displays/{id}/qr

Дисплей QR-кодов (Mertech QR-PA, QR-Screen) или второй монитор. Пустой payload — убрать QR. Сразу, не операция

Параметры

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

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

Поля · QrRequest

payloadstring
от 0
до 2000
topstring
от 0
до 100
bottomstring
от 0
до 100

JSON

{
  "payload": "string",
  "top": "string",
  "bottom": "string"
}

Ответ 200

Без тела.

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

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

curl

curl -X POST 'http://localhost:7790/api/v1/displays/1/qr' \
  -H 'Content-Type: application/json' \
  --data '{"payload":"string","top":"string","bottom":"string"}'

curl

curl -X POST 'https://cloud.hw-connector.ru/agent/api/v1/displays/1/qr' \
  -H 'X-Api-Key: hwk_…' \
  -H 'X-Device-Id: 42' \
  -H 'Content-Type: application/json' \
  --data '{"payload":"string","top":"string","bottom":"string"}'