Сервер WNAM QoW позволяет обеспечить взаимодействие с внешней информационной системой - например, системой мониторинга вашей организации, или универсальным дашбордом сервисов организации, по REST протоколу.
Для этого внешняя информационная система должна отправлять специальным образом сформированные запросы на API-эндпоинт сервера QoW. Для авторизации доступа используется передача заголовка "X-API-Key" со значением, соответствующем значению параметра netams.remoteToken, определенного в конфигурационном файле /home/qow/application.properties сервера.
Формат обмена данных - JSON, кодировка UTF-8. Все эндпоинты вызываются по методу HTTP GET.
Справочник допустимых эндпоинтов:
| URL | Параметры | Возвращаемое значение | Описание |
|---|---|---|---|
| /api/objects/listGroups | нет | ||
| /api/objects/getGroup/{groupId} | идентификатор группы | ||
| /api/objects/listSensors | нет | ||
| /api/objects/getSensor/{sensorId} | идентификатор сенсора | ||
| /api/objects/listAccessPoints | нет | ||
| /api/objects/getAccessPoint/{accessPointId} | идентификатор точки доступа | ||
| /api/objects/listTasks | нет | ||
| /api/objects/getTask/{taskId} | идентификатор задачи | ||
| /api/healthSummary/getLatest | |||
| /api/healthSummary/requestHealth |
Например:
Запрос информации о сенсоре
curl -X GET \
https://wifisensor-server/api/objects/getSensor/611a211ff1290747553498f4 \
-H 'X-API-Key: sxdgfgdfghdgjgfdhjlasdgf' \
-H 'cache-control: no-cache'
Ответ сервера
HTTP/1.1 200
Server: nginx/1.14.2
Date: Wed, 12 Jan 2022 12:20:59 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Set-Cookie: JSESSIONID=706F8360029679006C5548E26C0E1A33; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Requested-With,X-API-Key{
"id": "611a211ff1290747553498f4",
"mac": "94:83:C4:09:04:DC",
"location": "FNM_B_r220",
"name": "QoW-1",
"testingAccessPointIds": [
"614a0c47b6fb545d0e1ea1b0"
],
"groupId": "611a213bf1290747553498f9"
}