Procédure de récupération des données

  • Authentification initiale

    L’authentification initiale est décrite dans la sous-section Authentification.

    L’authentification initiale utilise l’adresse e-mail et le mot de passe d’un utilisateur existant. Pour cela, vous devez envoyer une requête POST, par exemple :

    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

  • Récupération de la liste des consommateurs

    Pour récupérer la liste des consommateurs, vous devez envoyer une requête GET, par exemple :

    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

    Les données sont récupérées page par page ("total_pages": 8 — nombre total de pages, "current_page": 2 — page en cours).

    Il convient d’organiser une récupération cyclique des données par numéro de page :

    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
}

    Pour la suite de la récupération des données (celle des archives de valeurs), nous aurons besoin des paramètres suivants :

    • "id": 13 ("customer_id": "13") — identifiant (clé unique) du consommateur dans le système.

  • Récupération de la liste des unités de comptage

    Pour récupérer la liste des unités de comptage, vous devez envoyer une requête GET, par exemple :

    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

    Les données sont récupérées page par page ("total_pages": 9 — nombre total de pages, "current_page": 2 — page en cours).

    Il convient d’organiser une récupération cyclique des données par numéro de page.

    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
}

    Pour la suite de la récupération des données (celle des archives de valeurs), nous avons besoin des paramètres suivants :

    • "equipment_id": 61 — identifiant de l’appareil de comptage.

    Pour la mise en correspondance des données (référentiels) :

    • "customer_id": 14 — identifiant du client ;
    • "equipment_type_id": 1 — identifiant du type de configuration de l’appareil de comptage.

  • Récupération des caractéristiques de l’objet

    Pour récupérer les caractéristiques d’une unité de comptage, vous devez envoyer une requête GET comportant l’identifiant de l’unité dans le chemin, par exemple :

    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 est l’identifiant de l’unité de comptage obtenu lors de la récupération de la liste des unités de comptage.

  • Récupération des types d’appareils de comptage

    Pour récupérer les types d’appareils de comptage, vous devez envoyer une requête GET, par exemple :

    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

    Il convient d’organiser une récupération cyclique des données selon les paramètres suivants :

    • page — numéro de page.

  • Récupération des canaux

    Pour récupérer les canaux avec leur rattachement au type d’appareil de comptage, vous devez envoyer une requête GET, par exemple :

    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

    Il convient d’organiser une récupération cyclique des données selon les paramètres suivants :

    • equipment_type_id — identifiant du type de configuration de l’appareil ;
    • page — numéro de page.

  • Récupération des messages des appareils

    Pour récupérer le référentiel des messages (codes d’événement/d’erreur) d’un type d’appareil de comptage, vous devez envoyer une requête GET, par exemple :

    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"

    Les paramètres de filtrage sont transmis dans la chaîne de requête :

    • equipment_type_id — identifiant du type d’appareil de comptage ;
    • archive_type_id — identifiant du type d’archive (facultatif, pour restreindre la sélection) ;
    • page — numéro de page.

  • Récupération des archives de relevés

    Pour récupérer les archives de relevés, vous devez envoyer une requête GET, par exemple :

    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

    Il convient d’organiser une récupération cyclique des données selon les paramètres suivants :

    • equipment_id — identifiant de l’appareil de comptage ;
    • archive_type — type d’archive (voir le référentiel) ;
    • fp_start — début de l’intervalle de temps ;
    • fp_end — fin de l’intervalle de temps ;
    • page — numéro de page.

  • Récupération de l’archive pour une période

    Pour récupérer l’archive pour une période, vous devez envoyer une requête GET, par exemple :

    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

    Il convient d’organiser une récupération cyclique des données selon les paramètres suivants :

    • equipment_id — identifiant de l’appareil de comptage ;
    • archive_type — type d’archive (voir le référentiel) ;
    • fp_start — début de l’intervalle de temps ;
    • fp_end — fin de l’intervalle de temps ;
    • page — numéro de page ;
    • channel_consolidation: 1 — paramètre de récupération unifiée.

  • Récupération de la configuration du compteur

    Pour récupérer la configuration du compteur, vous devez envoyer une requête GET, par exemple :

    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

    Il convient d’organiser une récupération cyclique des données selon les paramètres suivants :

    • equipment_id — identifiant de l’appareil de comptage ;
    • archive_type = “settings” ;
    • page — numéro de page.

  • Récupération de la date de la dernière session de communication

    Pour récupérer la date de la dernière session de communication de l’unité de comptage, vous devez envoyer une requête GET, par exemple :

    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

    Il convient d’organiser la récupération des données selon le paramètre suivant :

    • id — identifiant de l’unité de comptage.

  • Récupération des sessions de communication

    Pour récupérer les sessions de communication de la télémétrie, vous devez envoyer une requête GET, par exemple :

    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"

    Il convient d’organiser une récupération cyclique des données selon les paramètres suivants :

    • telemetry_id — identifiant de l’unité de télémétrie ;
    • fp_start — début de l’intervalle de temps ;
    • fp_end — fin de l’intervalle de temps ;
    • page — numéro de page.
Dernière mise à jour le

Cette page vous a-t-elle été utile ?

Saisissez votre recherche

↑↓ pour naviguer
Esc