Процедура вивантаження даних

  • Первинна автентифікація

    Первинну автентифікацію описано в підрозділі Автентифікація.

    Для первинної автентифікації використовують електронну пошту та пароль наявного користувача. Для цього потрібно надіслати POST-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, вказавши ідентифікатор вузла у шляху, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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-запит, наприклад:

    bash
    curl -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 — номер сторінки.
Останнє оновлення

Чи була ця сторінка корисною?