Proton 2D, Android 8.1, 2G/16G, WiFi, BT, 4G AMC-2280 + ПО Goods Web бессрочная лицензия 20ART1310171753 — руководство пользователя для работы с API GoodsWebServer [112/120]

Превью страниц Страница 112 / 120

Proton 2D, Android 8.1, 2G/16G, WiFi, BT, 4G AMC-2280 + ПО Goods Web бессрочная лицензия 20ART1310171753 [112/120] Ответ api

Руководство пользователя

ЦШК "ГЕКСАГОН" ПРИЛОЖЕНИЕ "GOODSWEB" Версия: 1.00 112/120

Все исключительные авторские права принадлежат ЦШК «Гексагон»

IP-адрес и порт подключения едины для всех типов взаимодействия с GoodsWebServer и

указываются в его настройках.

Путь (ws path) для подключения к API: /api

Пример url для подключения к API: ws://192.168.88.1:4000/api

5.4.1.4 Запрос API

После установки соединения сервер ожидает сообщение в виде JSON-строки,

интерпретируемой как API-запрос (далее - запрос). На верхнем уровне запрос должен содержать ключ

'action' со значением, соответствующем типу запроса (см. ниже). Остальные данные запроса зависят

от его типа и описаны в соответствующих разделах.

5.4.1.5 Ответ API

API вернёт данные в рамках установленного подключения. В зависимости от типа запроса

структура данных может быть различной, однако существуют общие принципы.

В ответ на запросы, представляющие собой команды и не ожидающие получения информации,

вернутся сообщения, содержащие ключ 'action' со значением 'status'.

Запросы, ожидающие информацию, получат её в сообщении с 'action' = 'upload'.

При наличии ошибки, информация о ней будет содержаться в значении ключа 'error'.

5.4.1.6 Завершение обмена

По умолчанию сервер не разрывает подключение и сохраняет его постоянно. Обязанность

закрытия подключения возлагается на клиента. Каждое сообщение со стороны API содержит ключ

'keep_conn' со значениями 'true' или 'false'. 'true' предполагает, что в очереди имеются сообщения,

которые будут отправлены клиенту позднее и необходимо сохранять подключение. 'false' - индикатор

того, что информации для клиента больше нет и от клиента ожидается закрытие подключения.

5.4.2 Поддерживаемые запросы GoodsWebServer API

5.4.2.1 Перечень запросов

Актуальные на момент обновления документации запросы (значения, принимаемые по ключу

'action'):

• 'add_handheld

• 'get_handhelds'

• 'del_handheld'

• 'sync_handhelds'

5.4.2.2 Описание запросов

Запросы содержат параметры и получают ответ с обозначением типа возвращаемой

информации в значении ключа 'action' (далее - информационное обозначение или обозначение)

1. 'add_handheld'

Запрос на добавление ТСД в перечень обслуживаемых сервером устройств.

Параметры (на верхнем уровне JSON):

'ip' - IP-адрес ТСД

'port' - порт

Ответ:

Сообщения с информационным обозначением 'status', содержат информацию о ходе операции.

2. 'get_handhelds'

Запрос на получение списка обслуживаемых ТСД.

Параметры: нет.

Ответ:

Сообщения с информационным обозначением 'status', содержат информацию о ходе операции.

Сообщение с обозначением 'upload' и списком устройств по ключу 'handhelds'.

Список устройств содержит структуры со следующими полями ключами): 'device_id', 'ip', 'port',

'blocked', 'recently_seen', 'title'

3. 'del_handheld'

Запрос на блокировку ТСД. Устройство останется в перечне обслуживаемых сервером

устройств, но не будет участвовать в информационном обмене. Параметры (на верхнем уровне

JSON):

'id' - идентификатор ТСД

Ответ:

Сообщения с информационным обозначением 'status', содержат информацию о ходе операции.

4. 'sync_handhelds'

Запрос на синхронизацию ТСД. При выполнении запроса сервер даст команду на

синхронизацию всем указанным в запросе устройствам. Для того чтобы указать устройства, с

Proton 2D, Android 8.1, 2G/16G, WiFi, BT, 4G AMC-2280 + ПО Goods Web бессрочная лицензия 20ART1310171753 — руководство пользователя для работы с API GoodsWebServer [112/120]

Содержание

Похожие устройства