WavIoT — беспроводная система учета ресурсов
Описание API
API модуля gateway
API - методы модуля gateway Модуль gateway выполняет функции NB-Fi базовой станции. Данный HTTP API-интерфейс предоставляет доступ к модулю gateway для администрирования и мониторинга базовой станции. Данные методы доступны как при подключении непосредственно к сетевому интерфейсу БС, так и на API – сервере http://api.waviot.ru Таблица 1. Сводная таблица всех API методов модуля gateway Описание URL Метод Требует авторизацию, роль Чтение номера БС /gateway/localid GET да, guest Чтение списка параметров БС /gateway/read_params GET да, guest Изменение параметров БС /gateway/write_params GET да, admin Конфигурирование GPS /gateway/gps GET да, admin Конфигурирование часов /gateway/time GET да, admin Чтение списка UL и DL пакетов БС /gateway/messages ...
26 May, 2020 Комментарии: 0
API модуля telecom
API - методы модуля telecom Модуль telecom выполняет функции NB-Fi телеком-cервера. Данный HTTP API-интерфейс позволяет получать, отправлять NB-Fi пакеты данных, конфигурировать режимы работы устройств, базовых станций, выполнять мониторинг работы сети и загружать лицензии на новые устройства. Данные API - методы доступны на сервере https://api.waviot.ru Таблица 1. Сводная таблица всех API методов модуля telecom Описание URL Метод Чтение списка UL, DL, ULAPP, INFO пакетов /telecom/api/messages GET Чтение списка DLAPP пакетов /telecom/api/dl_messages GET Чтение статуса DLAPP пакета /telecom/api/dl_message_status GET Отправка DLAPP пакета /telecom/api/send_dl GET Удаление UL, DL, ULAPP, INFO пакета /telecom/api/deletemessage GET Чтение параметров устройств /telecom/api/device GET ...
26 Nov, 2019 Комментарии: 0
API модуля driver_electro5
API методы модуля driver_electro5 Модуль driver_electro5 реализует поддержку приборов учета электроэнергии Вавиот Фобос. Данные методы доступны на API – сервере http://api.waviot.ru , а также при подключении непосредственно к сетевому интерфейсу УСПД. Для доступа к методам модуля необходимо использовать URL-преффикс /driver_electro5/ Получение показаний приборов учета Значение Описание Запрос Протокол http(s) Тип запроса GET или POST Путь /api/report/history Параметры modem Десятичный уникальный идентификатор модема прибора учета. Допускается массив значений через «,» profile Профиль из которого получены данные. Допускается массив значений через «,». Перечень вариантов см. ниже. Если параметр не задан – принимает все допустимые значения ...
28 Jun, 2019 Комментарии: 0
API УСПД Вавиот
Описание API УСПД «Вавиот». Вступление Подключение к УСПД Авторизация Доступные методы Методы модуля driver_electro5 Методы модуля gateway Методы модуля telecom Коды ошибок Вступление Программный интерфейс API предназначен для взаимодействия УСПД «Вавиот» со сторонними системами верхнего уровня с целью доступа к данным, содержащимся в базе данных УСПД, прямому доступу к устройствам сети NB-Fi (приборам учета электроэнергии), конфигурирования и контроля функционирования. API представляет собой набор программных методов, исполняющихся посредством HTTP GET либо POST запросов. Подключение к УСПД Для осуществления обмена данными с УСПД необходимо наличие TCP/IP канала между ПО верхнего уровня и физическим Ethernet интерфейсом УСПД. Порт для HTTP- обмена: 80 Авторизация Большинство методов API предполагают предварительную авторизацию клиента. В УСПД поддерживается два пользователя, имеющих роли guest и admin. Ниже описана последовательность действий...
14 Jan, 2019 Комментарии: 0
API облачной платформы Вавиот
Описание API облачной платформы «Вавиот». Вступление Авторизация Доступные методы Методы модуля driver_electro5 Методы модуля gateway Методы модуля telecom Методы модуля driver Методы модуля lk Вступление Программный интерфейс API предназначен для взаимодействия облачной платформы «Вавиот» со сторонними системами верхнего уровня с целью доступа к данным, содержащимся в базе данных, прямому доступу к устройствам сети NB-Fi , конфигурирования и контроля функционирования. API представляет собой набор программных методов, исполняющихся посредством HTTP GET либо POST запросов. Сервер, предоставляющий API: https://api.waviot.ru Авторизация Все методы API предполагают предварительную авторизацию клиента. Сервер, выполняющий авторизацию и регистрацию новых пользователей: https://auth.waviot.ru Авторизация Процедура авторизации предполагает передачу логина и пароля по защищенному каналу и получение в ответ JWT-токена. Токен возвращается в теле ответа...
25 Jul, 2019 Комментарии: 0
API модуля driver
API - методы модуля driver Таблица 1. Сводная таблица всех API методов модуля driver Описание URL Метод Отправка DL пакетов /api/dl POST Статус отправленных DL пакетов Запрос DL пакетов /api/dl GET Чтение состояний устройств /api/setting GET Запись состояний устройств /api/setting POST Запрос данных формата ROLL /api/roll GET Запрос данных формата EAV /api/eav GET Репарсинг бинарных пакетов /api/reparse GET Запрос списка id модемов /api/app_ids GET Проверка владельца модемов /api/check_ids GET Запрос метаданных приложения /api/metadata GET Отправка DL пакетов POST запрос: URL Список параметров Пример запроса /api/dl ...
02 Dec, 2019 Комментарии: 0
API авторизации в веб-сервисах
Единая авторизация Запрос: POST https://auth.waviot.ru/?action=user-login Content-type: application/json X-requested-with: XMLHttpRequest {"login": "example@example.com","password":"your_password"} Ответ в случае, если указаны правильные логин и пароль HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 { "sc": "...", "rt": "...", "WAVIOT_JWT": "...", "sessid": "..." } Ответ в случае, если указаны неправильные логин и пароль: HTTP/1.1 302 Moved Temporarily Далее для запросов на auth.waviot.ru/lk.waviot.ru/api.waviot.ru используем полученный JWT в заголовках ко всем запросам, требующим авторизацию. Обновление токенов или авторизация пользователя. Запрос может быть как get так и post Запрос: POST|GET https://auth.waviot.ru/?action=user-refresh Content-type: application/json X-requested-with: XMLHttpRequest {"login": "example@example.com","password":"your_password"} Ответ в случае, если...
01 Sep, 2021 Комментарии: 0
API личного кабинета ЖКХ
Переда началом работы не забудьте авторизоваться для получения JWT Дополнительную информацию об использовании API можно найти тут: https://lk.waviot.ru/api/ Получение основной информации о личном кабинете ЖКХ Запрос: GET https://lk.waviot.ru/api.general/info/ Ответ: HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 { "status": "ok", "config": { "domain": "lk.waviot.ru", "logo": "/icons/logo.png", "title": "WAVIoT", "support_email": "support@waviot.ru", "support_site": "https://waviot.makekb.com/28/", "locales": { "ru_RU": "Русский", "ua_UA": "Украинский", "en_US": "English", "mn_MN": "Монгол", "rs_RS": "Србија" } } } Получение основной информации о модеме Запрос: GET https://lk.waviot.ru/api.modem/info/?id=70B3B9 Authorization: bearer [JWT] Ответ при успешном выполнении запроса: HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 { "status": "ok", "modem": { "id":...
29 Aug, 2019 Комментарии: 0
API модуля HES
Контракты (contracts) – сущности инкапсулирующие в себе батчи. В рамках контракта создаются батчи. Дерево прав для hes API - методы модуля HES Возможные коды ответов HES: 200 - Смотри описание метода. 400 - Не верные входные параметры 401 - Не авторизован. Нужно получить или обновить JWT токен на auth. 403 - Нет доступа к запрашиваемому ресурсу, нужно получить правильные claims 404 - такой страницы не существует. 406 - Выход из сессии или аккаунта 500 - Ошибка при котором дальнейшие исполнение не возможно. Таблица 1. Сводная таблица всех API методов модуля HES Описани URL Метод Создание контракта /contracts_add POST Изменение контракта /contracts_edit POST Получение контрактов /contracts_get GET Данные по модемам /modem_getModems POST Вернуть все модему пл батчу /modem_getBatches GET Создание батча /batches_add POST Добавление модемов в батч /batches_addModems POST...
20 Feb, 2020 Комментарии: 0