Описание API oiot.ru

Подключение

API работает на HTTPS-запросах по URL oiot.ru/api/

Для работы достаточно сделать запрос по данному URL с определёнными параметрами и получить ответ сервера.

Пример: https://oiot.ru/api/v1/?param1=xx&param2=yy

Авторизация

Сервер отвечает только на запросы, в которых присутствуют две переменные: id и token. Их можно получить в личном кабинете.

Пример: https://oiot.ru/api/v1/?id=xx&token=yy

Ответ сервера

По умолчанию сервер возвращает массив со всеми последними показаниями счётчиков, которые привязаны к вашему аккаунту.

Параметр keys

Каждый прибор имеет уникальный ключ (например: 30AE5F9E98888093EF9ED4401A6BBDA0 или 927D0A0CF23FB7777EEC254E4ACFB9F8).

Если передать массив ключей, сервер вернёт в ответе показания только этих приборов.

Необязательно передавать ключ целиком. Вы можете указать не менее трёх начальных символов ключа — сервер найдёт их по начальному вхождению.

Пример: https://oiot.ru/api/v1/?id=xx&token=yy&keys[]=30AE5&keys[]=927D0

Параметр date

Если передать этот параметр, сервер вернёт в ответе последние известные показания приборов на указанную дату.

Формат даты: DD-MM-ГГГГ, где DD — день с ведущим нулём, MM — месяц с ведущим нулём, ГГГГ — четырёхзначный год.

Пример: https://oiot.ru/api/v1/?id=xx&token=yy&date=01-05-2020

Параметры date_start и date_finish

Если в запросе присутствуют эти параметры, сервер вернёт массив всех показаний за указанный период.

Это удобно для построения отчётов и графиков.

Существуют ограничения:

Пример: https://oiot.ru/api/v1/?keys[]=927D0&date_start=01-05-2020&date_finish=31-05-2020