Procedura di recupero dei dati

  • Autenticazione iniziale

    L’autenticazione iniziale è descritta nella sottosezione Autenticazione.

    Per l’autenticazione iniziale si utilizzano l’indirizzo e-mail e la password di un utente esistente. A tal fine è necessario inviare una richiesta POST, per esempio:

    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

  • Recupero dell’elenco dei consumatori

    Per recuperare l’elenco dei consumatori è necessario inviare una richiesta GET, per esempio:

    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

    I dati vengono recuperati pagina per pagina ("total_pages": 8 — numero totale di pagine, "current_page": 2 — pagina corrente).

    È necessario organizzare il recupero ciclico dei dati per numero di pagina:

    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
}

    Per proseguire il recupero dei dati (recupero degli archivi dei valori) serviranno i seguenti parametri:

    • "id": 13 ("customer_id": "13") — identificatore (chiave univoca) del consumatore nel sistema.

  • Recupero dell’elenco dei nodi di misura

    Per recuperare l’elenco dei nodi di misura è necessario inviare una richiesta GET, per esempio:

    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

    I dati vengono recuperati pagina per pagina ("total_pages": 9 — numero totale di pagine, "current_page": 2 — pagina corrente).

    È necessario organizzare il recupero ciclico dei dati per numero di pagina.

    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
}

    Per proseguire il recupero dei dati (recupero degli archivi dei valori) servono i seguenti parametri:

    • "equipment_id": 61 — identificatore del dispositivo di misura.

    Per l’allineamento dei dati (elenchi di riferimento):

    • "customer_id": 14 — identificatore del consumatore;
    • "equipment_type_id": 1 — identificatore del tipo di configurazione del dispositivo di misura.

  • Recupero delle caratteristiche dell’oggetto

    Per recuperare le caratteristiche di un nodo di misura è necessario inviare una richiesta GET con l’identificatore del nodo nel percorso, per esempio:

    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

    L’id è l’identificatore del nodo di misura ottenuto durante il recupero dell’elenco dei nodi di misura.

  • Recupero dei tipi di dispositivo di misura

    Per recuperare i tipi di dispositivo di misura è necessario inviare una richiesta GET, per esempio:

    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

    È necessario organizzare il recupero ciclico dei dati secondo i seguenti parametri:

    • page — numero di pagina.

  • Recupero dei canali

    Per recuperare i canali con l’associazione al tipo di dispositivo di misura è necessario inviare una richiesta GET, per esempio:

    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

    È necessario organizzare il recupero ciclico dei dati secondo i seguenti parametri:

    • equipment_type_id — identificatore del tipo di configurazione del dispositivo;
    • page — numero di pagina.

  • Recupero dei messaggi dei dispositivi

    Per recuperare l’elenco di riferimento dei messaggi (codici di evento/errore) di un tipo di dispositivo di misura è necessario inviare una richiesta GET, per esempio:

    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"

    I parametri di filtro vengono passati nella stringa di query:

    • equipment_type_id — identificatore del tipo di dispositivo di misura;
    • archive_type_id — identificatore del tipo di archivio (facoltativo, per restringere la selezione);
    • page — numero di pagina.

  • Recupero degli archivi delle letture

    Per recuperare gli archivi delle letture è necessario inviare una richiesta GET, per esempio:

    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

    È necessario organizzare il recupero ciclico dei dati secondo i seguenti parametri:

    • equipment_id — identificatore del dispositivo di misura;
    • archive_type — tipo di archivio (vedere l’elenco di riferimento);
    • fp_start — inizio dell’intervallo temporale;
    • fp_end — fine dell’intervallo temporale;
    • page — numero di pagina.

  • Recupero dell’archivio per un periodo

    Per recuperare l’archivio per un periodo è necessario inviare una richiesta GET, per esempio:

    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

    È necessario organizzare il recupero ciclico dei dati secondo i seguenti parametri:

    • equipment_id — identificatore del dispositivo di misura;
    • archive_type — tipo di archivio (vedere l’elenco di riferimento);
    • fp_start — inizio dell’intervallo temporale;
    • fp_end — fine dell’intervallo temporale;
    • page — numero di pagina;
    • channel_consolidation: 1 — parametro di recupero unificato.

  • Recupero della configurazione del contatore

    Per recuperare la configurazione del contatore è necessario inviare una richiesta GET, per esempio:

    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

    È necessario organizzare il recupero ciclico dei dati secondo i seguenti parametri:

    • equipment_id — identificatore del dispositivo di misura;
    • archive_type = “settings”;
    • page — numero di pagina.

  • Recupero della data dell’ultima sessione di comunicazione

    Per recuperare la data dell’ultima sessione di comunicazione del nodo di misura è necessario inviare una richiesta GET, per esempio:

    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

    È necessario organizzare il recupero dei dati secondo il parametro:

    • id — identificatore del nodo di misura.

  • Recupero delle sessioni di comunicazione

    Per recuperare le sessioni di comunicazione della telemetria è necessario inviare una richiesta GET, per esempio:

    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"

    È necessario organizzare il recupero ciclico dei dati secondo i seguenti parametri:

    • telemetry_id — identificatore dell’unità di telemetria;
    • fp_start — inizio dell’intervallo temporale;
    • fp_end — fine dell’intervallo temporale;
    • page — numero di pagina.
Ultimo aggiornamento il

Questa pagina è stata utile?

Digita per cercare nella documentazione

↑↓ per navigare
Esc