API

Описание 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

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

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

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

  • обе даты должны располагаться в рамках одноого месяца.
  • количество приборов не должно превышать 2
  • массив keys обязателен
  • параметр date запрещен

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