In this article, you will learn how to use the EI API integration in the platform.
Contents of this article:
Introduction
This App represents the integration between EI's API and the platform to ensure data insertion from all the installations. This app and the documentation is exclusive for EI Energia.
App's Requirements
In order to be able to use this app, you will need first to:
- Find the ID of the installation you would like to include in the platform in EI's CRM.
- Find out when the installation was ready and you started receiving data from it.
How does the integration work?
This integration will check hourly all the gateways that have been registered in the platform. Then, it will call EI's API and collect the data that has been gathered during the last hour. This data is afterwards inserted in the platform.
In order to have control or visualisation of the gateways that have been registered, there is a screen called "Status Integration", in which you will be able to see if there is any incidence with the installations from which we are collecting the data.
In order to insert data from your installations to the platform you should:
- Register the installation in the gateways' section of the platform.
- One hour later, you should access the "Integration Status" section and check the status of the new site, see if there has been any incidence.
- In case this installation has historical data, manually import it to the platform.
In the following sections, you will learn how to perform each of these steps.
Register an installation
In order to register an installation, you should create a virtual gateway in the platform. When configuring it, you will have to include:
- Key of the gateway = "EI_" + ID of the installation. Example: EI_I0003.
- Name of the gateway: The one you find most convenient
Verify all the installations
Once the installation has been registered, after an hour you should go to the settings menu and the page "Integration Status". You will see something like this:
This is the list of all the installations that have been registered in the platform, together with the status of the installation. The possible status and causes are:
- Success - No incidences: Everything is working properly for that installation.
- Warning - Missing readings: The connection is working properly but there are missing readings.
- Warning - No Value: An empty value is obtained for some readings.
- Error - Not found: The installation ID you configured has not been found in the EI's API.
- Error - EI API not available: The API is not responding and the data cannot be obtained.
- Error - Platform API not available: the platform's API is not responding and the data cannot be obtained.
- Error - Internal Error: Something is not working with the App itself.
If you would like to see more information about the calls that are being executed to the API, you can click on "Logs" and you will see a higher detail.
Manual data import
If you have registered an installation and you would like to insert historical data or data that was not correctly inserted, you could use the option Manual Data Import. In order to do so, you should:
- Choose the installation(s) for which you would like to import the data.
- Select the time and date from which the data import should be carried out to the final time and date.
- Click on "Manual Data Import".