Overview

This API has been designed for Schneider Electric internal use to handle multiple utility providers that are relevant to EcoStruxure products.

At present, the API provides access to electricity consumption data from Enedis Linky meters. The aim is to provide other utility provider data like gas, for as many countries as possible.

To request the addition of more data sources, contact ecostruxure.openness@se.com.

API overview and usage

The API currently supports following.

Utility Type Provider Country Features
Electricity Enedis France Domestic

  • Get consent* from Enedis users for access to their Linky meter data.
  • List the meters available from energy provider.
  • Get the daily energy consumption data for a given meter.


  • Commercial

  • Register an authorization from a customer.
  • Retrieve registered authorization for a customer.
  • Register for set of measurement for a customer from a utility provider.
  • List all data requests made with utility provider for a customer.
  • Retrieve a data request made with utility provider for a customer.
  • Documentation

    How to sign up

    This is an internal API product. Please contact ecostruxure.openness@se.com for access.

    Authentication guide

    The API is meant for Schneider Electric internal applications, however the data retrieved from third party providers are in the context of Schneider Electric customer. Hence Schneider Electric application must generate a token per customer using one of following steps to invoke data APIs.

    Schneider Electric application integrated with cIAM

    If the Schneider Electric application is integrated with cIAM, application will already have access to cIAM id_token. Schneider Electric application can exchange this id_token for API access token using Exchange cIAM id_token operation. CURL example below. This way the token generated is associated with the cIAM identity, the consent provided by the user will be stored against the cIAM identity.

    curl -X POST 'https://api.exchange.se.com/ecostruxure/v1/oauth/token' \
    
    -H 'Content-Type: application/x-www-form-urlencoded' \
    
    --data-urlencode 'id_token=base64encodedidtokenfromciam' \
    
    --data-urlencode 'grant_type=id_token' \
    
    --data-urlencode 'client_id=abcdeff' \
    
    --data-urlencode 'client_secret=******'
    
    

    Schneider Electric application not integrated with cIAM

    If the Schneider Electric application is not integrated with cIAM, application can generate an access token using Impersonate an user operation. CURL example below. This way the token generated is associated with the cIAM identity, the consent provided by the user will be stored against the cIAM identity.

    curl -X POST 'https://api.exchange.se.com/ecostruxure/v1/oauth-impersonate/token' \
    
    -H 'Content-Type: application/x-www-form-urlencoded' \
    
    --data-urlencode 'email=john.doe@yopmail.com' \
    
    --data-urlencode 'grant_type=user_token' \
    
    --data-urlencode 'client_id=abcdeff' \
    
    --data-urlencode 'client_secret=******'
    
    

    UserAccessToken

    Security schema accepts token generated through exchange of cIAM id_token or impersonation as bearer authorization token.

    Security Scheme Type: HTTP
    HTTP Authorization Scheme bearer

    Code Samples

    You can leverage the code samples provided to integrate the API faster in your application.

    Support

    Contact the SE Exchange support team at exchange.support@se.com and include:

    • Endpoint URL
    • Request/Response
    • Any additional information like Screenshots, Postman collections.

    Release Notes

    version Notes
    1.2.0 API enhancements to request load curve production data from Enedis.
    1.1.0 Enedis SGE Tier integration. Provides support to request data for commercial sites in France.
    1.0.0 Initial version