En este artículo, aprenderás cómo usar la integración de la plataforma con la API de EI Energía.
Contenido de este artículo:
Introducción
Esta aplicación representa la integración entre la API de EI y la plataforma para permitir la inserción de datos de las instalaciones monitorizadas por EI. Esta app y la documentación son exclusivas para EI Energía.
Requisitos de la aplicación
Para poder usar esta aplicación, primero necesitarás:
- Encontrar el ID de la instalación que te gustaría incluir en la plataforma en el CRM de EI.
- Encontrar desde cuándo dispones de datos de esta instalación.
¿Cómo funciona la integración?
Esta integración comprueba horariamente todos los concentradores que se hayan registrado en la plataforma. A continuación, llama a la API de EI y recoge todos los datos que se hayan ido acumulando en la última hora. Estos datos serán entonces insertados en la plataforma.
Para poder tener control o algún tipo de visualización sobre los concentradores que se han registrado, hay una pantalla llamada "Status Integration", donde podrás ver si ha ocurrido alguna incidencia con las instalaciones de las que estás recogiendo datos.
Para poder insertar datos de tus instalaciones a la plataforma deberías:
- Registrar la instalación en la sección de concentradores de la plataforma.
- Una hora más tarde, deberías acceder a la pantalla de "Status Integration" y verificar el estado de la nueva instalación para identificar si ha habido alguna incidencia.
- En caso de que esta instalación disponga de datos históricos, importar manualmente estos datos a la plataforma.
En los próximos apartados, aprenderás cómo llevar a cabo estos pasos.
Registrar una instalación
Para registrar una instalación, deberías crear un concentrador virtual en la plataforma. Cuando lo configures, deberás incluir:
- Clave del concentrador: "EI_" + ID de la instalación. Ejemplo: EI_I0003.
- Nombre del concentrador: Según convenga.
Verificar el estado de las instalaciones
Una vez la instalación esté registrada, pasada una hora deberías ir al menú de configuración y acceder a la página "Integration Status". Verás algo similar a lo siguiente:
Esta es la lista de todas las instalaciones que se han registrado en la plataforma, junto con el estado de cada una de ellas. Los posibles estados y causas son:
- Success - No incidences: Todo funciona correctamente con esta instalación.
- Warning - Missing readings: La conexión funciona correctamente pero faltan lecturas.
- Warning - No Value: Un valor vacío se está obteniendo para algunas lecturas.
- Error - Not found: El ID de la instalación que has configurado no se ha encontrado en la API de EI.
- Error - EI API not available: La API de EI no está respondiendo y los datos no se pueden obtener correctamente.
- Error - Platform API not available: La API de la plataforma no responde correctamente y no se pueden insertar los datos a la plataforma.
- Error - Internal Error: Algo no está funcionando correctamente con la App.
Si te gustaría ver más información sobre las llamadas que se están ejecutando a la API, puedes hacer click en "Logs" y podrás ver un mayor detalle.
Importar datos manualmente
Si has registrado una instalación y te gustaría insertar datos históricos o datos que no fueron procesados correctamente, puedes usar la opción de "Manual Data Import". Para hacerlo, deberías:
- Elegir la/s instalación/es para las que te gustaría importar datos.
- Seleccionar la fecha y hora desde la que te gustaría importar datos hasta la fecha y hora donde debería finalizar la importación.
- Hacer click en "Manual Data Import".