Procedimiento de descarga de datos

  • Autenticación inicial

    La autenticación inicial se describe en la subsección Autenticación.

    Para la autenticación inicial se utilizan el correo electrónico y la contraseña de un usuario existente. Para ello hay que enviar una solicitud POST, por ejemplo:

    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

  • Descarga de la lista de consumidores

    Para descargar la lista de consumidores hay que enviar una solicitud GET, por ejemplo:

    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

    Los datos se descargan página a página ("total_pages": 8 — número total de páginas, "current_page": 2 — página actual).

    Es necesario implementar la descarga cíclica de los datos por número de página:

    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
}

    Para continuar con la descarga de datos (la de los archivos de valores) necesitaremos los siguientes parámetros:

    • "id": 13 ("customer_id": "13") — identificador (clave única) del consumidor en el sistema.

  • Descarga de la lista de unidades de medición

    Para descargar la lista de unidades de medición hay que enviar una solicitud GET, por ejemplo:

    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

    Los datos se descargan página a página ("total_pages": 9 — número total de páginas, "current_page": 2 — página actual).

    Es necesario implementar la descarga cíclica de los datos por número de página.

    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
}

    Para continuar con la descarga de datos (la de los archivos de valores) necesitamos los siguientes parámetros:

    • "equipment_id": 61 — identificador del dispositivo de medición.

    Para la armonización de los datos (directorios):

    • "customer_id": 14 — identificador del cliente;
    • "equipment_type_id": 1 — identificador del tipo de configuración del dispositivo de medición.

  • Descarga de las características del objeto

    Para descargar las características de una unidad de medición hay que enviar una solicitud GET con el identificador de la unidad en la ruta, por ejemplo:

    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

    El id es el identificador de la unidad de medición obtenido al descargar la lista de unidades de medición.

  • Descarga de los tipos de dispositivo de medición

    Para descargar los tipos de dispositivo de medición hay que enviar una solicitud GET, por ejemplo:

    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

    Es necesario implementar la descarga cíclica de los datos con los siguientes parámetros:

    • page — número de página.

  • Descarga de los canales

    Para descargar los canales con su vinculación al tipo de dispositivo de medición hay que enviar una solicitud GET, por ejemplo:

    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

    Es necesario implementar la descarga cíclica de los datos con los siguientes parámetros:

    • equipment_type_id — identificador del tipo de configuración del dispositivo;
    • page — número de página.

  • Descarga de los mensajes de los dispositivos

    Para descargar el directorio de mensajes (códigos de evento/error) de un tipo de dispositivo de medición hay que enviar una solicitud GET, por ejemplo:

    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"

    Los parámetros de filtrado se pasan en la cadena de consulta:

    • equipment_type_id — identificador del tipo de dispositivo de medición;
    • archive_type_id — identificador del tipo de archivo (opcional, para acotar la selección);
    • page — número de página.

  • Descarga de los archivos de lecturas

    Para descargar los archivos de lecturas es necesario enviar una solicitud GET, por ejemplo:

    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

    Es necesario implementar la descarga cíclica de los datos con los siguientes parámetros:

    • equipment_id — identificador del dispositivo de medición;
    • archive_type — tipo de archivo (véase el directorio);
    • fp_start — inicio del intervalo de tiempo;
    • fp_end — fin del intervalo de tiempo;
    • page — número de página.

  • Descarga del archivo de un periodo

    Para descargar el archivo de un periodo hay que enviar una solicitud GET, por ejemplo:

    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

    Es necesario implementar la descarga cíclica de los datos con los siguientes parámetros:

    • equipment_id — identificador del dispositivo de medición;
    • archive_type — tipo de archivo (véase el directorio);
    • fp_start — inicio del intervalo de tiempo;
    • fp_end — fin del intervalo de tiempo;
    • page — número de página;
    • channel_consolidation: 1 — parámetro de descarga unificada.

  • Descarga de la configuración del contador

    Para descargar la configuración del contador hay que enviar una solicitud GET, por ejemplo:

    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

    Es necesario implementar la descarga cíclica de los datos con los siguientes parámetros:

    • equipment_id — identificador del dispositivo de medición;
    • archive_type = “settings”;
    • page — número de página.

  • Descarga de la fecha de la última sesión de comunicación

    Para descargar la fecha de la última sesión de comunicación de la unidad de medición hay que enviar una solicitud GET, por ejemplo:

    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

    Es necesario implementar la descarga de los datos con el parámetro:

    • id — identificador de la unidad de medición.

  • Descarga de las sesiones de comunicación

    Para descargar las sesiones de comunicación de telemetría hay que enviar una solicitud GET, por ejemplo:

    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"

    Es necesario implementar la descarga cíclica de los datos con los siguientes parámetros:

    • telemetry_id — identificador de la unidad de telemetría;
    • fp_start — inicio del intervalo de tiempo;
    • fp_end — fin del intervalo de tiempo;
    • page — número de página.
Última actualización el

¿Te resultó útil esta página?

Escribe para buscar en la documentación

↑↓ para navegar
Esc