Ablauf des Datenabrufs

  • Erstauthentifizierung

    Die Erstauthentifizierung wird im Unterabschnitt Authentifizierung beschrieben.

    Für die Erstauthentifizierung werden E-Mail-Adresse und Passwort eines vorhandenen Benutzers verwendet. Dazu ist eine POST-Anfrage zu senden, zum Beispiel:

    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

  • Liste der Verbraucher abrufen

    Um eine Liste der Verbraucher abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Die Daten werden seitenweise abgerufen ("total_pages": 8 — Gesamtzahl der Seiten, "current_page": 2 — aktuelle Seite).

    Der Datenabruf ist zyklisch über die Seitennummer zu steuern:

    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
}

    Für den weiteren Datenabruf (Abruf der Messwertarchive) benötigen wir die folgenden Parameter:

    • "id": 13 ("customer_id": "13") — Kennung (eindeutiger Schlüssel) des Verbrauchers im System.

  • Liste der Messknoten abrufen

    Um die Liste der Messknoten abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Die Daten werden seitenweise abgerufen ("total_pages": 9 — Gesamtzahl der Seiten, "current_page": 2 — aktuelle Seite).

    Der Datenabruf ist zyklisch über die Seitennummer zu steuern.

    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
}

    Für den weiteren Datenabruf (Abruf der Messwertarchive) benötigen wir die folgenden Parameter:

    • "equipment_id": 61 — Kennung des Messgeräts.

    Für den Datenabgleich (Verzeichnisse):

    • "customer_id": 14 — Kennung des Verbrauchers;
    • "equipment_type_id": 1 — Kennung des Konfigurationstyps des Messgeräts.

  • Objektkenndaten abrufen

    Um die Kenndaten eines Messknotens abzurufen, ist eine GET-Anfrage mit der Kennung des Knotens im Pfad zu senden, zum Beispiel:

    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

    Die id ist die Kennung des Messknotens, die beim Abruf der Liste der Messknoten ermittelt wurde.

  • Messgerätetypen abrufen

    Um die Messgerätetypen abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Der Datenabruf ist zyklisch über die folgenden Parameter zu steuern:

    • page — Seitennummer.

  • Kanäle abrufen

    Um die Kanäle mit Zuordnung zum Messgerätetyp abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Der Datenabruf ist zyklisch über die folgenden Parameter zu steuern:

    • equipment_type_id — Kennung des Konfigurationstyps des Geräts;
    • page — Seitennummer.

  • Gerätemeldungen abrufen

    Um das Verzeichnis der Meldungen (Ereignis-/Fehlercodes) für einen Messgerätetyp abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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"

    Die Filterparameter werden in der Abfragezeichenfolge übergeben:

    • equipment_type_id — Kennung des Messgerätetyps;
    • archive_type_id — Kennung der Archivtyp (optional, zur Eingrenzung der Auswahl);
    • page — Seitennummer.

  • Messwertarchive abrufen

    Um Messwertarchive abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Der Datenabruf ist zyklisch über die folgenden Parameter zu steuern:

    • equipment_id — Kennung des Messgeräts;
    • archive_type — Archivtyp (siehe Verzeichnis);
    • fp_start — Beginn des Zeitintervalls;
    • fp_end — Ende des Zeitintervalls;
    • page — Seitennummer.

  • Archiv für einen Zeitraum abrufen

    Um das Archiv für einen Zeitraum abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Der Datenabruf ist zyklisch über die folgenden Parameter zu steuern:

    • equipment_id — Kennung des Messgeräts;
    • archive_type — Archivtyp (siehe Verzeichnis);
    • fp_start — Beginn des Zeitintervalls;
    • fp_end — Ende des Zeitintervalls;
    • page — Seitennummer;
    • channel_consolidation: 1 — Parameter für den vereinheitlichten Abruf.

  • Konfiguration des Zählers abrufen

    Um die Konfiguration des Zählers abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Der Datenabruf ist zyklisch über die folgenden Parameter zu steuern:

    • equipment_id — Kennung des Messgeräts;
    • archive_type = “settings”;
    • page — Seitennummer.

  • Datum der letzten Kommunikationssitzung abrufen

    Um das Datum der letzten Kommunikationssitzung des Messknotens abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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

    Der Datenabruf ist über den folgenden Parameter zu steuern:

    • id — Kennung des Messknotens.

  • Kommunikationssitzungen abrufen

    Um die Kommunikationssitzungen der Telemetrie abzurufen, ist eine GET-Anfrage zu senden, zum Beispiel:

    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"

    Der Datenabruf ist zyklisch über die folgenden Parameter zu steuern:

    • telemetry_id — Kennung der Telemetrieeinheit;
    • fp_start — Beginn des Zeitintervalls;
    • fp_end — Ende des Zeitintervalls;
    • page — Seitennummer.
Zuletzt aktualisiert am

War diese Seite hilfreich?

Tippen, um zu suchen

↑↓ navigieren
Esc