Onboarding
Submit an online application. Enbridge Gas will review your application and communicate the outcome via email. Please provide all mandatory details and review the terms and conditions. You will receive an email if additional information is required. Before you submit the application, please make sure you understand the technical, functional and legal aspects of Enbridge Gas Green Button® registration and have the necessary infrastructure in place. Our implementation follows Energy Services Provider Interface (ESPI) version 3.3 of the official specification published by NAESB (North America Energy Standards Board). You'll be able to purchase the standard from NAESB website - https://www.naesb.org/ESPI_Standards.asp.
Our implementation follows the standards mentioned in ESPI version 3.3. If your application is not compatible with the standard, you won't be able to access our data. It is your responsibility to implement ESPI version 3.3 as we will not provide support.
Enbridge Gas uses this information to uniquely identify you and verify the legitimacy of your application.
Enbridge Gas will provide this information during the customer authorization process to enable informed customer decisions before providing authorization.
We use OAuth 2.0 for authorization as per the Green Button implementation standard. Notify URI will be used to notify you when the files are ready for bulk requests so that you can download the data from the Secure File Transfer Protocol (SFTP) server. Redirect URI will be used to redirect the customer once authorization has been granted.
You must maintain an unexpired, unrevoked Rivest Shamir Adleman (RSA) certificate with a public key length of at least 2048 bits. We use Transport Layer Security (TLS) 1.3 for information exchange and you’ll have to maintain the same as well.
Once your application has been reviewed, a member of the Enbridge Gas technical team will reach out to the registered email to start your onboarding to the data sharing platform. As part of the email we’ll share additional technical details including client id, client secret and instructions for technical onboarding.
As part of your onboarding, our technical team will let you know when to perform connectivity testing. You will be sent an email outlining the steps to take to ensure connectivity.
Once your Application Programming Interface (API) “currentStatus” is “1” you will be able to successfully connect to our data sharing platform.
Visit this link to review the Terms of Use.
We will process your application as soon as we can. Once onboarding is approved, our technical team will reach out with more information to complete the onboarding tasks.
You will be able to start the customer authorization process as soon as you successfully complete API connectivity testing.
API connectivity testing is the last step in the onboarding process. Completion of API testing will set your status as onboarded in our data sharing platform. If you don’t complete API testing within 30 days of receiving the email from Enbridge Gas, then your application will expire and you’ll have to restart the process by submitting a new application.
Please follow this link and use the “Contact us” option to submit a request to update your information.
Consent
We use industry standard and Green Button Alliance™ approved OAUth 2.0 for customer consent. A Customer starts from the third party website, gets directed to the Enbridge Gas authorization server and is presented with the scope of use of their data. Customers approve the authorization request and get redirected back to the Redirect URI with the authorization code. The Third party exchanges the authorization code for an access token and refresh token. The Authorization code is valid for 10 minutes. The access token is valid for one hour and the refresh token is valid for one year.
The authorization is valid until the expiry date selected by the customer. If the customer has not selected an expiry date then the authorization will never expire.
No. An online account is not mandatory to provide consent to provide third party authorization. Customers can provide offline consent by entering some details to verify their identity.
Where a customer has provided offline consent(FB_40), Enbridge Gas will send a notification to the third party’s notify URI. Third parties can access the authorization resource endpoint with the client_access_token to retrieve details about scope, validity, etc. Since offline consent(FB_40) does not use the OAuth 2.0 flow, Enbridge Gas can only provide data for such customers via the bulk API endpoints. Batch or resource endpoints don’t contain any data for offline consent(FB_40).
Data access
Access the list of APIs provided by Enbridge Gas here.
Our CMD APIs follow Green Button standards. We are providing APIs for Application Information, Authorization, Service Status, Resource, Batch and Bulk. We have provided details about tokens to be used for each API and whether we will provide synchronous or asynchronous response. The API description should provide you details about the expected payload.
We support REST for bulk data requests. When you access our bulk API, you’ll receive a 202 response immediately if the request was sent with the correct token. We’ll process your request in a batch mode and send you the Batchlist via the Notify URI. You’ll have to use the URIs from the Batchlist to get the data, use Client_Access_Token when you access the URIs. Please note that – our backend system allows bulk data sharing between 7 am – 4 pm ET only. If you request the Batchlist URIs outside of this window, your request will be refused.
Functional blocks supported
To see the functional blocks supported by Enbridge Gas, and how the data category from the customer consent maps to the functional blocks, download the file Functional Blocks Supported.pdf
If you have any technical issues and/or any other question not addressed here, please contact us and include as much detail as possible.
GREEN BUTTON and the Green Button Logo are registered trademarks owned by Departments of the U.S. Government.
GREENBUTTON CONNECT MY DATA and GREENBUTTON DOWNLOAD MY DATA are registered trademarks owned by the U.S. Department of Energy.
The GREEN BUTTON ALLIANCE and the Green Button Alliance Logo are trademarks of Green Button Alliance, Inc.