Overview

EcoStruxure™ Energy and Sustainability Scoring Internal API allows Schneider Electric applications to configure buildings that needs benchmarking by calculating performance scores using the building energy and sustainability data.

API overview and usage

This API enables the following operations:

Sites metadata

  • Retrieve all sites belonging to which the connected user has access, along site metadata needed for performance scores calculation (e.g. gross area, building occupants, operating hours, etc)

Sites registration

  • Allows the Schneider Electric application to register a site for calculating performance scores by sharing site timeseries details automatically.

Performance scores

  • Read current and historical scores for a given site
  • Supported Types: Daily, Monthly, Average, Local Average
  • Supported Categories: Electricity, Fuel, Water, Waste, Human Experience

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 SE internal applications, application can choose one of following method to generate token and invoke API on behalf of a customer.

SE application integrated with cIAM

If the SE application is integrated with cIAM, application will already have access to cIAM id_token. SE 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=******'

SE application not integrated with cIAM

If the SE 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=******'

UserToken

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

Operations and Resource Model

Operations and Resource Model diagram

Support

Contact our Exchange support team at exchange.support@se.com and include,

- Endpoint URL

- Request/Response of the URL

- Any additional information like Screenshots, Postman collections

Get help from the community here

➔ Next to Auth