Порядок выгрузки данных
Первичная аутентификация
Первичная аутентификация описана в подразделе Аутентификация.
При первичной аутентификации используются адрес электронной почты и пароль существующего пользователя. Для этого необходимо отправить POST-запрос, например:
bashcurl -i --header "Content-Type: application/json" \ --request POST \ --data '{"email":"api-user@example.com","password":"Str0ngPas$"}' \ https://api.vadsro.eu/api/v1/auth/sign_inВыгрузка списка потребителей
Чтобы выгрузить список потребителей, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{"page":"2"}' \ https://api.vadsro.eu/api/v1/customersДанные выгружаются постранично (
"total_pages": 8— общее количество страниц,"current_page": 2— текущая страница).Необходимо организовать циклическую выгрузку данных по номеру страницы:
json{"data":[ { "id":13, "name":"Example National Sports Federation", "subdivision_type_name":"Unit Owner", "inn":"1000000042", "contact_number":"+49-30-5550100" }, ... ], "total_pages":8, "current_page":2, "next_page":3 }Для дальнейшей выгрузки данных (архивов значений) понадобятся следующие параметры:
"id": 13("customer_id": "13") — идентификатор (уникальный ключ) потребителя в системе.
Выгрузка списка узлов учёта
Чтобы выгрузить список узлов учёта, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{"page":"2"}' \ https://api.vadsro.eu/api/v1/stationsДанные выгружаются постранично (
"total_pages": 9— общее количество страниц,"current_page": 2— текущая страница).Необходимо организовать циклическую выгрузку данных по номеру страницы.
json{"data":[ { "id":18, "name":"Example Beverages Production GmbH", "equipment_type_id":1, "equipment_brand_name":"BK", "phone":"+49-30-5550101", "equipment_id":61, "customer_id":14 } ... ], "total_pages":9, "current_page":2, "next_page":3 }Для дальнейшей выгрузки данных (архивов значений) понадобятся следующие параметры:
"equipment_id": 61— идентификатор прибора учёта.
Для сопоставления данных (справочники):
"customer_id": 14— идентификатор потребителя;"equipment_type_id": 1— идентификатор типа конфигурации прибора учёта.
Выгрузка характеристик объекта
Чтобы выгрузить характеристики узла учёта, необходимо отправить GET-запрос с идентификатором узла в пути запроса, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ https://api.vadsro.eu/api/v1/stations/134/characteristicsЗдесь
id— идентификатор узла учёта, полученный при выгрузке списка узлов учёта.Выгрузка типов приборов учёта
Чтобы выгрузить типы приборов учёта, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{"page":"1"}' \ https://api.vadsro.eu/api/v1/equipment_typesНеобходимо организовать циклическую выгрузку данных по следующим параметрам:
page— номер страницы.
Выгрузка каналов
Чтобы выгрузить каналы с привязкой к типу прибора учёта, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{"equipment_type_id": "2", "page":"1"}' \ https://api.vadsro.eu/api/v1/channel_archive_typesНеобходимо организовать циклическую выгрузку данных по следующим параметрам:
equipment_type_id— идентификатор типа конфигурации прибора;page— номер страницы.
Выгрузка сообщений устройств
Чтобы выгрузить справочник сообщений (кодов событий и ошибок) для типа прибора учёта, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ "https://api.vadsro.eu/api/v1/message_equipment_types?equipment_type_id=11&page=1"Параметры фильтрации передаются в строке запроса:
equipment_type_id— идентификатор типа прибора учёта;archive_type_id— идентификатор типа архива (необязательный, для сужения выборки);page— номер страницы.
Выгрузка архивов показаний
Чтобы выгрузить архивы показаний, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{"archive_type": "hourly", "equipment_id":"25", "fp_end":"2021-02-20", "fp_start":"2021-02-01", "page":"1"}' \ https://api.vadsro.eu/api/v1/channel_dataНеобходимо организовать циклическую выгрузку данных по следующим параметрам:
equipment_id— идентификатор прибора учёта;archive_type— тип архива (см. справочник);fp_start— начало интервала времени;fp_end— конец интервала времени;page— номер страницы.
Выгрузка архива за период
Чтобы выгрузить архив за период, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{"archive_type": "hourly", "equipment_id":"25", "fp_end":"2021-02-20", "fp_start":"2021-02-01", "page":"1", "channel_consolidation": "1"}' \ https://api.vadsro.eu/api/v1/channel_dataНеобходимо организовать циклическую выгрузку данных по следующим параметрам:
equipment_id— идентификатор прибора учёта;archive_type— тип архива (см. справочник);fp_start— начало интервала времени;fp_end— конец интервала времени;page— номер страницы;channel_consolidation: 1— параметр объединённой выгрузки.
Выгрузка конфигурации прибора учёта
Чтобы выгрузить конфигурацию прибора учёта, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{"archive_type": "settings", "equipment_id":"25", "page":"1"}' \ https://api.vadsro.eu/api/v1/channel_dataНеобходимо организовать циклическую выгрузку данных по следующим параметрам:
equipment_id— идентификатор прибора учёта;archive_type = “settings”;page— номер страницы.
Выгрузка даты последнего сеанса связи
Чтобы выгрузить дату последнего сеанса связи узла учёта, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ --data '{ "id": "1816"}' https://api.vadsro.eu/api/v1/stations/last_seance_event_timeНеобходимо организовать выгрузку данных по параметру:
id— идентификатор узла учёта.
Выгрузка сеансов связи
Чтобы выгрузить сеансы связи телеметрии, необходимо отправить GET-запрос, например:
bashcurl -i --header "access-token: *********************" \ --header "token-type: Bearer" \ --header "client: **********************" \ --header "uid: api-user@example.com" \ --request GET \ --header "Content-Type: application/json" \ "https://api.vadsro.eu/api/v1/seances?telemetry_id=85&fp_start=2021-11-02&fp_end=2021-11-30&page=1"Необходимо организовать циклическую выгрузку данных по следующим параметрам:
telemetry_id— идентификатор блока телеметрии;fp_start— начало интервала времени;fp_end— конец интервала времени;page— номер страницы.
Эта страница была полезной?
Спасибо за ваш отзыв!