EDDIE Framework

Appearance

Region Connector for France (Enedis) ​

This README will guide you through the process of configuring a region connector for one of the biggest permission administrators in France.

Prerequisites ​

  • Register a user with Enedis here. To register, try to log in with an unregistered email address and you will be prompted to register.
  • Go to the datahub and log in with the user you registered.
  • Navigate to "Mon compte" and then "Nouvelle entité" and enter into a contract for DATA CONNECT. Approval of this contract may take some time.
  • Once the contact has been entered, navigate to "Mon compte" and then "Mes applications".
  • Create an application in the sandbox environment. This application will be used for getting an application in the production environment approved.
  • Once the application has been created, edit it and switch it to the production environment. For this you will need to provide a valid callback URL. This URL needs to point to the region connector authorization-callback, for example https://url-to-your-eddie-instance/region-connectors/fr-enedis/authorization-callback. You will also need to provide a URL where Enedis can check your running application in order to switch it to production. Point the URL to wherever you plan to host a Connect with EDDIE button.
  • Wait for the application to be approved. This may take some time.
  • After it has been approved, update the client id and secret used to configure the region connector.

Configuration of the Region Connector ​

The region connector needs a set of configuration values to be able to function correctly, how you provide these values depends on the way you deploy the region connector.

Configuration valuesDescription
region-connector.fr.enedis.basepathPath to the data connect endpoints: https://gw.ext.prod.api.enedis.fr for production.
region-connector.fr.enedis.client.idPublic key/id of the application you want to switch to production. Can be found under "Mes applications".
region-connector.fr.enedis.client.secretSecret key of the application you want to switch to production. Can be found under "Mes applications".
region-connector.fr.enedis.pollingConfigures when future data should be polled. Uses spring Cron syntax. The default is 17:00 every day. We recommend polling at most once per day, otherwise EDDIE can hit the rate limit, which leads to errors.

The region connector can be configured using Spring properties or environment variables. When using environment variables, the configuration values need to be converted in the following way:

  • Replace all non-alphanumeric characters with an underscore (_)
  • Optionally convert all letters to upper case
properties
region-connector.fr.enedis.basepath=https://gw.ext.prod.api.enedis.fr
region-connector.fr.enedis.client.id=a5d5ce56-2bca-123d-1ccd-46a28f1ac132
region-connector.fr.enedis.client.secret=11d145d8-25a6-55c1-b6af-04ac332211b1
region-connector.fr.enedis.polling=0 0 17 * * *
yaml
region-connector:
  fr:
    enedis:
      basepath: https://gw.ext.prod.api.enedis.fr
      client:
        id: a5d5ce56-2bca-123d-1ccd-46a28f1ac132
        secret: 11d145d8-25a6-55c1-b6af-04ac332211b1
      polling: 0 0 17 * * *
dotenv
REGION_CONNECTOR_FR_ENEDIS_BASEPATH=https://gw.ext.prod.api.enedis.fr
REGION_CONNECTOR_FR_ENEDIS_CLIENT_ID=a5d5ce56-2bca-123d-1ccd-46a28f1ac132
REGION_CONNECTOR_FR_ENEDIS_CLIENT_SECRET=11d145d8-25a6-55c1-b6af-04ac332211b1
REGION_CONNECTOR_FR_ENEDIS_POLLING=0 0 17 * * *

Running the Region Connector via EDDIE ​

If you are using EDDIE, the region connector should appear in the list of available region connectors if it has been configured correctly.