API личного кабинета Waviot

Последние изменения: 05.09.2025

API личного кабинета Waviot

Содержание:

Синтаксис запроса
Получение основных данных о модеме
История изменения температуры/напряжения батарейки модема
Получение даты последнего сообщения модема
Получение списка значений регистратора по модему
Показания счетчика по id модема и каналу учета
Получение полной информации об элементе дерева
Получение списка доступных элементов дерева
Получение только элементов дерева внутри указанного элемента
Получение списка дочерних элементов дерева
Получение списка модемов, привязанных к указанному элементу
Получить события счётчика
Получить тарифы для элемента дерева
Получение информации по балансу элемента дерева

Синтаксис запроса

Чтобы обратиться к методу API Waviot, необходимо выполнить POST или GET запрос такого вида:

https://lk.waviot.ru/api.TYPE/METHOD_NAME?PARAMETERS&key=API_KEY

Запрос состоит из нескольких частей:

TYPE — тип API, к которому вы хотите обратиться

METHOD_NAME — название метода API, к которому вы хотите обратиться

PARAMETERS — входные параметры соответствующего метода API, последовательность пар name="value," разделенных амперсандом. Список параметров указан в подробном описании метода. Если в запросе указан GET и POST параметры с одним именем, приоритет имеет POST параметр

API_KEY — персональный ключ доступа. Если ключ доступа не указан, то проверяется cookie-авторизация

Список методов

* Во всех методах вы можете получить доступ только к тем модемам/счётчикам, которые привязаны к доступным для вас элементам дерева

Получение основных данных о модеме

https://lk.waviot.ru/api.modem/info/?id=7C0A77

Параметр	Описание
id	HEX id модема

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
modem (array) Информация о модеме
- battery (float) Напряжение батарейки, вольт
- battery_type (int) Id типа батареи
- dl_change_timestamp (int) Timestamp времени выполнения последней downlink команды
- hw_version (string) Версия hardware
- sw_version (string) Версия ПО
- last_config_time (int) Timestamp времени
- last_info_message (int) Timestamp последнего сообщения с информацией о модеме
- last_station_time (int) Timestamp последней активности базовой станции
- modem_type (int) Id типа модема
- protocol_id (int) Id протокола
- temperature (int) Температура устройства в °C

История изменения температуры/напряжения батарейки модема

https://lk.waviot.ru/api.modem/history/?id=7C0A77

Параметр	Описание
id	HEX id модема

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
history (array) История изменения температуры/напряжения батарейки модема
- timestamp (int) Timestamp
- temperature (int) Температура устройства в °C
- voltage (float) Напряжение батарейки, вольт

Получение даты последнего сообщения модема

https://lk.waviot.ru/api.modem/get_last_message/?id=7C0A77

Параметр	Описание
id	HEX id модема

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
packet (array) Данные пакета
- id (int) Id пакета
- modem_id (int) HEX id модема
- received_time (string) Timestamp получения пакета
- event_time (int) Timestamp пакета
- processed (char) Флаг обработки пакета
- protocol_id (int) Id протокола
- iterator (int) Итератор

Получение списка значений регистратора по модему

https://lk.waviot.ru/api.data/get_values/?modem_id=7C0A77

Параметр	Описание
modem_id	HEX id модема
from	Unix timestamp момента, начиная с которого ведётся выборка
to	Unix timestamp момента, до которого ведётся выборка
round_ts	Округлять время до часа

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
registrators (array) Набор регистраторов
- [registrator_id] Возможные значения: Registrator values | array

Показания счётчика по id модема и каналу учёта

https://lk.waviot.ru/api.data/get_modem_channel_values/?modem_id=7C0A77&channel=160

Параметр	Описание
modem_id	HEX id модема
channel	Id канала
from	Unix timestamp момента, начиная с которого ведётся выборка
to	Unix timestamp момента, до которого ведётся выборка

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
channel (string) Id канала
values (array) Значения в формате timestamp (ключ) -> значение счётчика

Получение полной информации об элементе дерева

https://lk.waviot.ru/api.data/get_full_element_info/?id=924468

Параметр	Описание
id	ID элемента дерева

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
devices (array)
- id (int) Id девайса
- name (int) Название устройства
- class_name (string) Название класса девайса
- config_time (int) Timestamp
- device_sn (string) Заводской №
- modem_id (int) HEX id модема
- device_time (int) Timestamp на устройстве
- timezone (string) Часовой пояс
- registrators (array) Набор регистраторов

Получение полного списка доступных элементов дерева

https://lk.waviot.ru/api.tree/get_tree/

Получение только элементов дерева внутри указанного элемента

https://lk.waviot.ru/api.tree/get_tree/?id=1554

Параметр	Описание
id	ID элемента дерева
account	Номер лицевого счёта клиента
fields	Список получаемых свойств дерева через запятую (lastname, firstname, middlename, appartment, city, district, street, locality, building, entrance, account, vm_code, ovm_code)

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
tree (array) Список элементов дерева
- [tree_id] (array) Элемент дерева
  - id (int) ID элемента дерева
  - name (int) Название элемента дерева
  - type (int) Id типа элемента дерева
  - [tree_id] (array) Элемент дерева

Получение списка дочерних элементов дерева

https://lk.waviot.ru/api.tree/get_elements/?id=14218

Параметр	Описание
id	ID элемента дерева

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
tree (array) Список элементов дерева
- [tree_id] (array) Элемент дерева
  - id (int) ID элемента дерева
  - name (int) Название элемента дерева
  - type (int) Id типа элемента дерева
  - [tree_id] (array) Элемент дерева

Получение списка модемов, привязанных к указанному элементу

https://lk.waviot.ru/api.tree/get_modems/?id=1554

Параметр	Описание
id	ID элемента дерева

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
modems

Получить события счётчика

https://lk.waviot.ru/api.data/get_events/?modem_id=70D5BC

Параметр	Описание
modem_id	HEX id модема
from	Timestamp начала отчёта
to	Timestamp конца отчёта

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
events (array) Список событий
- code (array) Код события
  - decimal (int) Десятичный код события
  - hex (string) hex код события
- description (string) Описание события
- param (int) Параметр события

Получить тарифы для элемента дерева

https://lk.waviot.ru/api.tree/get_tariffs/?id=1554

Параметр	Описание
id	ID элемента дерева
timestamp	Timestamp момента, на который мы хотим получить тарифы

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
tariffs (array) Tariff channels list
- currency (string) Код валюты (ISO 4217)
- cost (float) Стоимость
- timestamp_from (int) Timestamp начала действия тарифа
- timestamp_to (int) Timestamp окончания действия тарифа

Получение информации по балансу элемента дерева

https://lk.waviot.ru/api.data/get_balance_info/?from=1510866000&to=1513458000&elementId=19063

Параметр	Описание
from	Timestamp начала отчёта
to	Timestamp конца отчёта
elementId	ID элемента дерева

Результат

Возвращает объект, содержащий поля:

status (string) Возможные значения: ok | error Статус выполнения запроса
balance Набор каналов с данными о балансе
- [channel_id] (array) Код канала
  - balance (float) Баланс
  - computed_summ (float) Сумма по дочерним счётчикам
  - e (float) Небаланс в %
  - summator_summ (float) Данные суммирующего регистратора, например, счётчика КТП
  - data (array) Данные, из которых считается баланс
    - [modem_id] (array) HEX id модема
      - device_sn (string) Заводской №
      - element_name (string) Название элемента дерева
      - element_vm_code (string) ВМ код
      - element_ovm_code (string) ОВМ код
      - start (int) Показания на начало запрашиваемого периода
      - diff (int) Потребление за запрашиваемый период
      - end (int) Показания на конец запрашиваемого периода
      - last_message_timestamp (int) Timestamp последнего сообщения
      - modem_id (string) Модем
      - unit_id (string) Единица измерения

Список каналов

Помогла ли вам статья?