Сервер WICO позволяет обеспечить взаимодействие с внешней информационной системой - например, системой мониторинга вашей организации, по HTTP/REST протоколу. Для этого внешняя информационная система должна отправлять специальным образом сформированные запросы на API-эндпоинт сервера WICO. При помощи API внешняя система может получить справочники различных объектов (точек доступа, групп, SSID, клиентов) сервера, состояние последнего измерения по заданному объекту.
Формат обмена данных - JSON, кодировка UTF-8. Все эндпоинты вызываются по методу HTTP GET. Ответ сервера - в формате JSON.
Справочник допустимых эндпоинтов API:
URL | Параметры | Возвращаемое значение | Описание |
/monitor | нет | Краткая информация о системе. | Системные параметры, количество групп, точек доступа, SSID и активных клиентов. |
/monitor/groups | нет | Массив краткой информации по всем группам в системе с количеством SSID, точек доступа и клиентов по каждой группе. | |
/monitor/accesspoints | Необязательный параметр groupId — идентификатор группы | Массив краткой информации по всем точкам доступа в системе с количеством клиентов и SSID по каждому устройству. Фильтр по группам. | Запрос выполнения измерения для заданного объекта. Параметры объекта передаются в URL запросе в виде ключ=значение например https://dev.wico.pro/monitor/accesspoints?groupId=652700a05b4b6c76779307ee |
/monitor/ssids | Необязательные параметры groupId — идентификатор группы, profileId — профиль SSID уникальный номер | Массив краткой информации по всем SSID системы с количеством клиентов по каждому SSID. Фильтр по группам и/или SSID. | Пример запроса https://dev.wico.pro/monitor/ssids?groupId=652700a05b4b6c76779307ee&profileId=4 |
/monitor/clients | Необязательные параметры groupId — идентификатор группы profileId — профиль SSID уникальный номер | Массив краткой информации по всем активным клиентам системы. Фильтр по группам и/или по SSID. |
Важно! Выдаются сокращенные сведения об объектах, полная информация об объекте (как она хранится на сервере) в данном API не предоставляется.
Объект сервер: ip , версия, время работы сервера, загрузка cpu, ram и hdd. А так же краткая информация по агентам, количество групп, SSID, точек доступа и активных клиентов.
При вызове команды GET https://dev.wico.pro/monitor/ получаем объект JSON
Объект список групп: по каждой id группы, имя группы, количество клиентов, SSID и точек доступа в группе.
При вызове команды GET https://dev.wico.pro/monitor/groups получаем объект JSON
Объект список точек доступа: по каждой id-идентификатор, имя, версия, mac, ip, группа в которую входит точка, количество клиентов на точке, количество SSID. А так же работает точка или нет. Можно фильтровать список по идентификатору группы(groupId) как в примере ниже.
При вызове команды GET https://dev.wico.pro/monitor/accesspoints?groupId=652700a05b4b6c76779307ee получаем объект JSON
Объект список SSID: id - идентификатор, имя, режим безопасности, номер профиля и состояние, а так же количество подключенных клиентов. Можно фильтровать список по идентификатору группы(groupId) или профилю SSID(profileId) как в примере ниже.
При вызове команды GET https://dev.wico.pro/monitor/ssids?profileId=8 получаем объект JSON
Объект список клиентов: по каждому mac- адрес, имя, accessPoint — идентификатор точки доступа, bssid, ssid -имя сети, profileId - профиль ssid, id группы, уровень сигнала rssi, количество переданных и принятых байт (txBytes и rxBytes). Количество входящих и исходящих пакетов (txPackets и rxPackets) . Можно фильтровать список по идентификатору группы (groupId) или профилю ssid (profileId) .
При вызове команды GET https://dev.wico.pro/monitor/clients получаем объект JSON
