Postup načítania údajov

  • Prvotná autentifikácia

    Prvotná autentifikácia je opísaná v časti Autentifikácia.

    Na prvotnú autentifikáciu sa používa e-mail a heslo existujúceho používateľa. Na tento účel je potrebné odoslať požiadavku POST, naprí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čítanie zoznamu odberateľov

    Na načítanie zoznamu odberateľov je potrebné odoslať požiadavku GET, naprí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

    Údaje sa načítavajú po stránkach ("total_pages": 8 – celkový počet stránok, "current_page": 2 – aktuálna stránka).

    Údaje je potrebné načítavať cyklicky podľa čí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
    }

    Na ďalšie načítanie údajov (načítanie archívov nameraných hodnôt) budeme potrebovať tieto parametre:

    • "id": 13 ("customer_id": "13") – identifikátor (jedinečný kľúč) odberateľa v systéme.
  • Načítanie zoznamu meracích uzlov

    Na načítanie zoznamu meracích uzlov je potrebné odoslať požiadavku GET, naprí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
    

    Údaje sa načítavajú po stránkach ("total_pages": 9 – celkový počet stránok, "current_page": 2 – aktuálna stránka).

    Údaje je potrebné načítavať cyklicky podľa čí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
    }

    Na ďalšie načítanie údajov (načítanie archívov nameraných hodnôt) potrebujeme tieto parametre:

    • "equipment_id": 61 – identifikátor meracieho zariadenia.

    Na zosúladenie údajov (číselníky):

    • "customer_id": 14 – identifikátor odberateľa;
    • "equipment_type_id": 1 – identifikátor typu konfigurácie meracieho zariadenia.
  • Načítanie charakteristík objektu

    Na načítanie charakteristík meracieho uzla je potrebné odoslať požiadavku GET s identifikátorom uzla v ceste, naprí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 meracieho uzla získaný pri načítaní zoznamu meracích uzlov.

  • Načítanie typov meracích zariadení

    Na načítanie typov meracích zariadení je potrebné odoslať požiadavku GET, naprí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

    Údaje je potrebné načítavať cyklicky podľa týchto parametrov:

    • page – číslo stránky.
  • Načítanie kanálov

    Na načítanie kanálov s väzbou na typ meracieho zariadenia je potrebné odoslať požiadavku GET, naprí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

    Údaje je potrebné načítavať cyklicky podľa týchto parametrov:

    • equipment_type_id – identifikátor typu konfigurácie zariadenia;
    • page – číslo stránky.
  • Načítanie správ zariadení

    Na načítanie číselníka správ (kódov udalostí/chýb) pre typ meracieho zariadenia je potrebné odoslať požiadavku GET, naprí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"

    Parametre filtrovania sa odovzdávajú v reťazci dopytu:

    • equipment_type_id – identifikátor typu meracieho zariadenia;
    • archive_type_id – identifikátor typu archívu (voliteľné, na zúženie výberu);
    • page – číslo stránky.
  • Načítanie archívov nameraných hodnôt

    Na načítanie archívov nameraných hodnôt je potrebné odoslať požiadavku GET, naprí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

    Údaje je potrebné načítavať cyklicky podľa týchto parametrov:

    • equipment_id – identifikátor meracieho zariadenia;
    • archive_type – typ archívu (pozri číselník);
    • fp_start – začiatok časového intervalu;
    • fp_end – koniec časového intervalu;
    • page – číslo stránky.
  • Načítanie archívu za obdobie

    Na načítanie archívu za obdobie je potrebné odoslať požiadavku GET, naprí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

    Údaje je potrebné načítavať cyklicky podľa týchto parametrov:

    • equipment_id – identifikátor meracieho zariadenia;
    • archive_type – typ archívu (pozri číselník);
    • fp_start – začiatok časového intervalu;
    • fp_end – koniec časového intervalu;
    • page – číslo stránky;
    • channel_consolidation: 1 – parameter jednotného načítania.
  • Načítanie konfigurácie merača

    Na načítanie konfigurácie merača je potrebné odoslať požiadavku GET, naprí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

    Údaje je potrebné načítavať cyklicky podľa týchto parametrov:

    • equipment_id – identifikátor meracieho zariadenia;
    • archive_type = “settings”;
    • page – číslo stránky.
  • Načítanie dátumu poslednej komunikačnej relácie

    Na načítanie dátumu poslednej komunikačnej relácie meracieho uzla je potrebné odoslať požiadavku GET, naprí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

    Údaje je potrebné načítavať podľa parametra:

    • id – identifikátor meracieho uzla.
  • Načítanie komunikačných relácií

    Na načítanie komunikačných relácií telemetrie je potrebné odoslať požiadavku GET, naprí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"

    Údaje je potrebné načítavať cyklicky podľa týchto parametrov:

    • telemetry_id – identifikátor telemetrickej jednotky;
    • fp_start – začiatok časového intervalu;
    • fp_end – koniec časového intervalu;
    • page – číslo stránky.
Naposledy aktualizované

Bola táto stránka užitočná?