Description: Integrated Energy Data Resource Program is overseen by the State of New York. The utilities that participate in this program are:
Website: http://greenbutton.iedr.nyserda.ny.gov
Utility ID:
IEDR
(this is the utility identifier you use in our API)
After registering with Integrated Energy Data Resource Program as a third party, to request authorizations from Integrated Energy Data Resource Program customers and test accounts, you can use any of these methods:
IEDR
in the
url parameter or when you create a
Form.
Once a customer has authorized, you will see an Authorization appear on your dashboard and via both our JSON API and Green Button API.
When your first register as a third party, your registration status is set to Sandbox mode. This means you can only request data from test accounts, so you can try it out or start building an integration, but real customers won't be able to authorize data sharing with you yet. Integrated Energy Data Resource Program will review your registration, then you'll get an email letting you know that you can now switch your status to Live mode in your settings.
During the OAuth authorization flow, we allow Integrated Energy Data Resource Program customers to authenticate by logging into their utility accounts. However, since third parties may not have a real customer account when they start, we also offer a "test scenario" option. Third parties can pre-select which option they want their OAuth authorize request to default to by their preferred authentication choice to the scope string.
Scope parameter format:
auth-{type}[-{value}]
Full scope string example with authentication option (percent encoded):
scope=FB%3D4_16_51%3BAdditionalScope%3Dauth-test-test_residential
Type | Can Have Value? | Description | Scope String Example |
---|---|---|---|
utility |
Yes | Pre-selects a utility for the customer, and can be used with other options.
Possible values:
|
auth-utility-rge auth-utility-nyseg_auth-phone-5554443333 |
sso |
No |
Try to use single sign-on to authenticate the customer using their utility account.
Compatible utilities:
|
auth-sso |
account |
Yes | Try to lookup the customer via their utility account number. | auth-account-111111111-1 |
phone |
Yes | Try to lookup the customer via the phone number they have on file at the utility. | auth-phone-111-111-1111 |
email |
Yes | Try to lookup the customer via the email they have on file at the utility. | auth-email-uapi-test-residential%40example.com |
address |
Yes | Try to lookup the customer via their utility billing address. | auth-address-333%20W%20EL%20CAMINO%20REAL%20STE%20600%2C%20SUNNYVALE%20CA%2094087 |
Since the Integrated Energy Data Resource Program OAuth authorization flow uses their authentication system by default, that means you can't use UtilityAPI's default test usernames to manually simulate a test scenario. Instead, below we have created some special test accounts you can simulate to try out the various authentication methods.
Try one with your Integrated Energy Data Resource Program data share link
(you aren't logged into an account that has a registered Integrated Energy Data Resource Program client)
Phone Number | Equivalent Test Scenario | Description |
---|---|---|
111-111-1111 |
residential |
A residential account with 1 meter per service type (e.g. electric). |
222-222-2222 |
commercial |
A commercial account with 1 meter per service type (e.g. electric). |
333-333-3333 |
badlogin |
Simulate error where we couldn't find that customer. |
Email Address | Equivalent Test Scenario | Description |
---|---|---|
uapi-test-residential-account1@example.com |
residential |
A residential account with 1 meter per service type (e.g. electric). |
uapi-test-commercial-account1@example.com |
commercial |
A commercial account with 1 meter per service type (e.g. electric). |
uapi-test-badlogin@example.com |
badlogin |
Simulate error where we couldn't find that customer. |
Physical Address | Equivalent Test Scenario | Description |
---|---|---|
100 DEMO AVE, POUGHKEEPSIE, NY 12601 |
residential |
A Central Hudson residential account with 1 electric meter and 1 gas meter. |
222 MAIN ST, POUGHKEEPSIE, NY 12601 |
commercial |
A Central Hudson commercial account with 1 electric meter and 1 gas meter. |
100 DEMO AVE, SPRING VALLEY, NY 10952 |
residential |
A Con Edison residential account with 1 electric meter and 1 gas meter. |
222 MAIN ST, SPRING VALLEY, NY 10952 |
commercial |
A Con Edison commercial account with 1 electric meter and 1 gas meter. |
100 DEMO AVE, SPRING VALLEY, NY 10952 |
residential |
A Liberty Utilities residential account with 1 electric meter and 1 gas meter. |
222 MAIN ST, MERRICK, NY 11566 |
commercial |
A Liberty Utilities commercial account with 1 electric meter and 1 gas meter. |
100 DEMO AVE, BINGHAMTON, NY 13902 |
residential |
A NYSEG residential account with 1 electric meter and 1 gas meter. |
222 MAIN ST, BINGHAMTON, NY 13902 |
commercial |
A NYSEG commercial account with 1 electric meter and 1 gas meter. |
100 DEMO AVE, BROOKLYN, NY 11226 |
residential |
A National Fuel residential account with 1 gas meter. |
222 MAIN ST, BROOKLYN, NY 11226 |
commercial |
A National Fuel commercial account with 1 gas meter. |
100 DEMO AVE, BROOKLYN, NY 11217 |
residential |
A National Grid residential account with 1 electric meter and 1 gas meter. |
222 MAIN ST, BROOKLYN, NY 11217 |
commercial |
A National Grid commercial account with 1 electric meter and 1 gas meter. |
100 DEMO AVE, SPRING VALLEY, NY 10952 |
residential |
A Orange & Rockland residential account with 1 electric meter and 1 gas meter. |
222 MAIN ST, SPRING VALLEY, NY 10952 |
commercial |
A Orange & Rockland commercial account with 1 electric meter and 1 gas meter. |
100 DEMO AVE, HEWLETT, NY 11557 |
residential |
A PSEG Long Island residential account with 1 electric meter. |
222 MAIN ST, HEWLETT, NY 11557 |
commercial |
A PSEG Long Island commercial account with 1 electric meter. |
100 DEMO AVE, BINGHAMTON, NY 13902 |
residential |
A RG&E residential account with 1 electric meter and 1 gas meter. |
222 MAIN ST, BINGHAMTON, NY 13902 |
commercial |
A RG&E commercial account with 1 electric meter and 1 gas meter. |
100 NOWHERE ST, ALBANY, NY 12203 |
badlogin |
Simulate error where we couldn't find that customer. |
Account Number | Equivalent Test Scenario | Description |
---|---|---|
111111111-1 |
residential |
A residential account with 1 meter per service type (e.g electric). |
222222222-1 |
commercial |
A commercial account with 1 meter per service type (e.g electric). |
333333333-3 |
badlogin |
Simulate error where we couldn't find that customer. |
Username | Password | Equivalent Test Scenario | Description |
---|---|---|---|
test_residential_user |
test_residential_user |
residential |
A residential customer with 2 accounts and 2 meters per service type (e.g electric). |
test_commercial_user |
test_commercial_user |
commercial |
A commercial customer with 2 accounts and 2 meters per service type (e.g electric). |
test_badlogin |
test_badlogin |
badlogin |
Simulate error where a credential is incorrect. |
Test Account | Equivalent Test Scenario | Description |
---|---|---|
test_residential_account1 |
residential |
A residential customer with 1 account and 1 meter per service type (e.g electric). |
test_residential_user |
residential |
A residential customer with 2 accounts and 2 meters per service type (e.g electric). |
test_commercial_account1 |
commercial |
A commercial customer with 1 account and 1 meter per service type (e.g electric). |
test_commercial_user |
commercial |
A commercial customer with 2 accounts and 2 meters per service type (e.g electric). |
test_badlogin |
badlogin |
Simulate error where we couldn't find that customer. |
If you want to send a one-time passcode to a real phone number or email to see what it looks like, you can prefix a special string to your phone number or email during lookup time and we'll set that number as the test scenario's OTP contact method. NOTE: These are intended for manual testing and not for automated testing (since they will really send an OTP), so please use our test credentials or the /test-submit API for automated tests.
Format | Equivalent Test Scenario | Description |
---|---|---|
TEST_residential_account1_<your_phone_number> TEST_residential_account1_<your_email>
|
residential |
A residential account with 1 meter per service type (e.g. electric). |
TEST_commercial_account1_<your_phone_number> TEST_commercial_account1_<your_email>
|
commercial |
A commercial account with 1 meter per service type (e.g. electric). |
TEST_badlogin_<your_phone_number> TEST_badlogin_<your_email>
|
badlogin |
Simulate error where we couldn't find that customer. |
To demonstrate how you can integrate the GBC OAuth authorization process into your apps and websites, we offer a demo third party website that can be configured with any GBC client, so long as it has a specific redirect_uri added. We have also created public, sandbox-only GBC clients that you can try out (see table below).
Client ID | Company Name | Pre-configured Demo Link |
---|---|---|
IEDR_ccccccccc |
Test Company | Link |