API (Application Programming Interface) системы Телеметрия 4.0 на данный момент главным образом предназначен для передачи показаний со счетчиков о потреблении за выбранный период на сторонний сервис пользователя.
Существует достаточно много инструментов для работы с API. Но в этом руководстве мы рассмотрим, как использовать Postman для выполнения запросов к API Телеметрия 4.0. Postman представляет из себя достаточно удобный инструмент для тестирования и автоматизации работы с API.
Для начала работы с API Вам потребуется:
- создать учетную запись в системе Телеметрия 4.0
- создать проект, добавить в проект приобретенное УСПД, подключить к УСПД счетчик, данные о потреблении которого Вы планируете передавать, установить вес импульса и начальные показания счетчика
- в настройках доступа подключенного счетчика указать профиль пользователя, учетная запись которого будет использоваться для авторизации при запросе к API (вероятно, Ваша учетная запись)
- CLIENT - идентификатор клиента и SECRET - ключ клиента для работы с API, которые Вы можете получить обратившись к нам.
Переходим к непосредственной работе с Postman. Вы можете использовать, например, web-версию данного сервиса: Postman
После регистрации аккаунта Вы попадете на стартовую страницу, на которой выберете опцию отправки API запроса:
В описании API сервиса Телеметрия 4.0 есть примеры запросов, а также URL токена авторизации: Cервис Телеметрия.рф. Описание API r.2.02 (2023-11-29).pdf
При использовании Postman для получения индивидуального токена нет необходимости в отдельных POST-запросах.
Вы просто формируете интересующий Вас GET-запрос:
Во вкладке Авторизация выбираете протокол авторизации OAuth 2.0:
Заполняете учетные данные:
|
URL токена авторизации можно найти в описании API: Cервис Телеметрия.рф. Описание API r.2.02 (2023-11-29).pdf
В качестве Client ID и Client Secret используйте полученные у нас CLIENT и SECRET, а в качестве Username и Password - логин и пароль от учетной записи в Телеметрии 4.0. |
И генерируете новый токен авторизации:
У Вас появится текущий токен, который теперь будет автоматически подставляться в Ваши GET-запросы к API Телеметрии, а благодаря функции Auto-refresh еще и автоматически обновляться:
Пример выходных данных GET-запроса на получение отчета по списку "Доступные мне счетчики":
Для получения отчета "Динамика потребления" по конкретному счетчику Вам будет необходимо:
- ввести в поле запроса соответствующий URL из описания API Cервис Телеметрия.рф. Описание API r.2.02 (2023-11-29).pdf
- подставить в него уникальный идентификатор интересующего Вас счетчика
- указать желаемый интервал между срезами данных о потреблении
В результате на GET-запрос о динамике потребления по конкретному счетчику получаем ответ:
