Postup načítání dat

  • Počáteční autentizace

    Počáteční autentizace je popsána v části Autentizace.

    Pro počáteční autentizaci se používá e-mail a heslo existujícího uživatele. K tomu je třeba odeslat požadavek POST, například:

    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

  • Načtení seznamu odběratelů

    Pro načtení seznamu odběratelů je třeba odeslat požadavek GET, například:

    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

    Data se načítají po stránkách ("total_pages": 8 — celkový počet stránek, "current_page": 2 — aktuální stránka).

    Načítání dat je nutné provádět cyklicky podle čísla stránky:

    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
}

    Pro další načítání dat (načtení archivů hodnot) budeme potřebovat následující parametry:

    • "id": 13 ("customer_id": "13") — identifikátor (jedinečný klíč) odběratele v systému.

  • Načtení seznamu měřicích jednotek

    Pro načtení seznamu měřicích jednotek je třeba odeslat požadavek GET, například:

    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

    Data se načítají po stránkách ("total_pages": 9 — celkový počet stránek, "current_page": 2 — aktuální stránka).

    Načítání dat je nutné provádět cyklicky podle čísla stránky.

    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
}

    Pro další načítání dat (načtení archivů hodnot) potřebujeme následující parametry:

    • "equipment_id": 61 — identifikátor měřicího zařízení.

    Pro sladění dat (číselníky):

    • "customer_id": 14 — identifikátor odběratele;
    • "equipment_type_id": 1 — identifikátor typu konfigurace měřicího zařízení.

  • Načtení charakteristik objektu

    Pro načtení charakteristik měřicí jednotky je třeba odeslat požadavek GET s identifikátorem jednotky v cestě, například:

    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

    Hodnota id je identifikátor měřicí jednotky získaný při načtení seznamu měřicích jednotek.

  • Načtení typů měřicích zařízení

    Pro načtení typů měřicích zařízení je třeba odeslat požadavek GET, například:

    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

    Načítání dat je nutné provádět cyklicky podle následujících parametrů:

    • page — číslo stránky.

  • Načtení kanálů

    Pro načtení kanálů s vazbou na typ měřicího zařízení je třeba odeslat požadavek GET, například:

    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

    Načítání dat je nutné provádět cyklicky podle následujících parametrů:

    • equipment_type_id — identifikátor typu konfigurace zařízení;
    • page — číslo stránky.

  • Načtení zpráv zařízení

    Pro načtení číselníku zpráv (kódů událostí/chyb) pro typ měřicího zařízení je třeba odeslat požadavek GET, například:

    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"

    Parametry filtru se předávají v dotazovacím řetězci:

    • equipment_type_id — identifikátor typu měřicího zařízení;
    • archive_type_id — identifikátor typu archivu (volitelný, pro zúžení výběru);
    • page — číslo stránky.

  • Načtení archivů odečtů

    Pro načtení archivů odečtů je třeba odeslat požadavek GET, například:

    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

    Načítání dat je nutné provádět cyklicky podle následujících parametrů:

    • equipment_id — identifikátor měřicího zařízení;
    • archive_type — typ archivu (viz číselník);
    • fp_start — začátek časového intervalu;
    • fp_end — konec časového intervalu;
    • page — číslo stránky.

  • Načtení archivu za období

    Pro načtení archivu za období je třeba odeslat požadavek GET, například:

    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

    Načítání dat je nutné provádět cyklicky podle následujících parametrů:

    • equipment_id — identifikátor měřicího zařízení;
    • archive_type — typ archivu (viz číselník);
    • fp_start — začátek časového intervalu;
    • fp_end — konec časového intervalu;
    • page — číslo stránky;
    • channel_consolidation: 1 — parametr sjednoceného načtení.

  • Načtení konfigurace měřidla

    Pro načtení konfigurace měřidla je třeba odeslat požadavek GET, například:

    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

    Načítání dat je nutné provádět cyklicky podle následujících parametrů:

    • equipment_id — identifikátor měřicího zařízení;
    • archive_type = “settings”;
    • page — číslo stránky.

  • Načtení data poslední komunikační relace

    Pro načtení data poslední komunikační relace měřicí jednotky je třeba odeslat požadavek GET, například:

    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

    Načítání dat je nutné provádět podle parametru:

    • id — identifikátor měřicí jednotky.

  • Načtení komunikačních relací

    Pro načtení komunikačních relací telemetrie je třeba odeslat požadavek GET, například:

    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"

    Načítání dat je nutné provádět cyklicky podle následujících parametrů:

    • telemetry_id — identifikátor telemetrické jednotky;
    • fp_start — začátek časového intervalu;
    • fp_end — konec časového intervalu;
    • page — číslo stránky.
Naposledy aktualizováno

Byla tato stránka užitečná?

Začněte psát a vyhledávejte

↑↓ navigace
Esc