Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Сервер WICO Контроллер позволяет обеспечить взаимодействие с внешней информационной системой - например, системой мониторинга вашей организации, по HTTP/REST протоколу. Для этого внешняя информационная система должна отправлять специальным образом сформированные запросы на API-эндпоинт сервера WICOконтроллера. При помощи API внешняя система может получить справочники различных объектов (точек доступа, групп, SSID, клиентов) сервера, состояние последнего измерения по заданному объекту.

...

Справочник допустимых эндпоинтов 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 не предоставляется.

...

При вызове команды GET https://dev.wico.pro/monitor/accesspoints?groupId=652700a05b4b6c76779307ee получаем объект JSON



 

Объектсписок SSID: id - идентификатор, имя, режим безопасности, номер профиля и состояние, а так же количество подключенных клиентов. Можно фильтровать список по идентификатору группы(groupId) или профилю SSID(profileId) как в примере ниже.

При вызове команды GEThttps://dev.wico.pro/monitor/ssids?profileId=8 получаем объект JSON



 

Объектсписок клиентов: по каждомуmac- адрес, имя, accessPoint — идентификатор точки доступа, bssid, ssid -имя сети, profileId - профиль ssid,id группы, уровень сигнала rssi, количество переданных и принятых байт (txBytes и rxBytes). Количество входящих и исходящих пакетов(txPackets и rxPackets). Можно фильтровать список по идентификатору группы(groupId) или профилю ssid (profileId) .

...