API DEL IME
Integre automáticamente sus datos en el IME
Envío de datos a la API IME
La API IME proporciona una interfaz programable para enviar datos directamente al sistema IME sin utilizar la interfaz gráfica de usuario. Esto permite una integración perfecta con diversas aplicaciones y sistemas, facilitando la automatización de procesos y la gestión de datos.
¿Cómo me conecto a la API?
Antes de enviar datos a la API del IME, debe obtener un token de acceso. Este token garantiza que las solicitudes a la API son seguras y están autorizadas. Para obtener este token, tiene que pedirnos acceso enviándonos una solicitud por correo electrónico a it@imageau.com. Después, cuando haga una petición a la api, tiene que poner «Authorization» en la cabecera y «Bearer {your_access_token}» en el valor.
Envío de datos
URL: https: //emi.imageau.com/api/data Este punto final se utiliza para añadir datos del sensor al IME.
Cuerpo de la solicitud
El cuerpo de la solicitud debe contener los datos que desea enviar. Estos datos deben estar formateados en JSON.
La bandera es una cadena de caracteres única que se utiliza para identificar el sensor al que se van a enviar los datos.
Ejemplo de solicitud de datos horarios de 2 sensores diferentes:
{
«datos»: [
{
«bandera»: «bandera_1
«fecha»: «2024-01-01 00:01:00»,
«valor»: 10.5
},
{
«bandera»: «bandera_1»,
«fecha»: «2024-01-01 00:02:00»,
«valor»: 10.8
},
{
«bandera»: «bandera_2»,
«fecha»: «2022-03-21 00:01:00»,
«valor»: 108,4
},
{
«bandera»: «bandera_2»,
«fecha»: «2022-03-21 00:02:00»,
«valor»: 108.9
}
]
}
Respuesta
Si los datos se envían correctamente, la API devolverá una respuesta confirmando el éxito de la operación. En caso contrario, la API devolverá un mensaje de error.
Tratamiento de errores
Ejemplos de códigos de error :
400 Solicitud incorrecta: La solicitud no era válida o estaba mal formada.401 No autorizado: El token de acceso falta, no es válido o ha caducado.403 Prohibido: El acceso al recurso está prohibido.404 No encontrado: No se ha encontrado el recurso solicitado.500 Error interno del servidor.
El mapa de los puntos finales de la API
| Características | Método | Punto final | Descripción |
|---|---|---|---|
| Enviar datos | POST | /api/datos | Enviar datos directamente a la API |
Envío de archivos de datos a través de FTP/SFTP al IME
La mayoría de las veces, los datos procedentes de las instalaciones de producción de agua se añaden mediante el envío de archivos de datos extraídos del sistema de supervisión o directamente de los sensores. A continuación, estos archivos se envían al servidor ImaGeau o se ponen a disposición en un servidor dedicado.
Los archivos se envían / se ponen a disposición al menos una vez al día en el servidor con los datos del día anterior, o de los 2/3 últimos días de deslizamiento (para garantizar la continuidad de los datos en caso de fallo en el envío de los datos de un día).
La frecuencia de exportación podría ser mayor, con archivos depositados cada hora, por ejemplo.
Solución 1: Enviar los archivos al servidor IMAGEAU
Solución 2: Hacer que los archivos estén disponibles en un servidor dedicado
Configuración de los archivos
Paso de tiempo de medición
Al menos 1 dato al día para los medidores del nivel del agua y los piezómetros, por ejemplo. Pero para la supervisión de instalaciones de producción, y especialmente para el cálculo de indicadores (nivel estático, caudal específico, etc.), el paso temporal mínimo es de 15 minutos (o menos) para nivel/caudal y de 1 hora o menos para volumen.
Formato
Los archivos deben enviarse en texto claro, con una codificación única, y deben contener
- una columna de fecha/hora
- una columna de valores
- una columna de código ID/bandera/variable, que debe ser única para que los datos puedan integrarse con los sensores correctos. Este código debe estar preferiblemente en el archivo, pero también puede estar en el nombre del archivo.
Ejemplo de formatos ya utilizados con IME :
Ejemplo con columnas y código de fecha/hora, valor y variable
Ejemplo con un código de variable en el nombre del fichero, una columna de fecha, una columna de hora y una columna de valor
Ejemplo con un código variable integrado en el nombre del fichero y en las cabeceras de las columnas, de la forma: sondeo IMAGEAU_nivel_flujo_fuente / sondeo IMAGEAU_temperatura_fuente / …