Description: None.
Website: https://greenbutton.demoutility.com/
Utility ID:
DEMOUTILITY
(this is the utility identifier you use in our API)
In order for you to request data from Ameren customers, you must register with Ameren as a third party company.
As part of their Green Button Connect My Data (GBCMD) program, Ameren is using UtilityAPI's EE/DER Engagement Platform to allow third-party companies to request data access from Ameren customers. Authorizations use the Green Button OAuth process, which means that third-parties have to be pre-registered with Ameren so they can be assigned a client_id.
After registering with Ameren as a third party, to request authorizations from Ameren customers and test accounts, you can use any of these methods:
DEMOUTILITY 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. Ameren 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.
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 |
|---|---|---|---|
sso |
No |
Try to use single sign-on (OpenIDConnect) to authenticate the customer. This is the default option.
If you don't want us to automatically trying to see if the user is
logged in to their Ameren account, add
|
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-5554443333 |
email |
Yes |
Try to lookup the customer via the email they have on file at the utility. |
auth-email-joe%40example.com |
address |
Yes |
Try to lookup the customer via their utility billing address. |
auth-address-123%20Main%20St%2C%20Anytown%2C%20CA%2012345 |
lastbill |
Yes |
Authenticate using a customer's latest bill date and amount. The prefill value for this authentication type is the customer's account number. |
auth-lastbill-111111111-1 |
test |
Yes | Authenticate using a specific test scenario. | auth-test-test_residential |
Since the Ameren 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 (account_number,phone,email,address,sso,lastbill or test).
Try one with your Ameren data share link
(you aren't logged into an account that has a registered Ameren client)
| Account Number | Equivalent Test Scenario | Description |
|---|---|---|
111111111-1 |
residential |
A residential customer with 1 account and 3 services (one water and one electric and one gas). |
222222222-2 |
commercial |
A commercial customer with 2 accounts and 5 services (one water and three electric and one gas). |
| Phone Number | Equivalent Test Scenario | Description |
|---|---|---|
+11111111111 |
residential |
A residential customer with 1 account and 3 services (one water and one electric and one gas). |
+22222222222 |
commercial |
A commercial customer with 2 accounts and 5 services (one water and three electric and one gas). |
| Email Address | Equivalent Test Scenario | Description |
|---|---|---|
heather.homeowner@example.com |
residential |
A residential customer with 1 account and 3 services (one water and one electric and one gas). |
acmecorp@example.com |
commercial |
A commercial customer with 2 accounts and 5 services (one water and three electric and one gas). |
| Physical Address | Equivalent Test Scenario | Description |
|---|---|---|
111 ANYWHERE ST, ANYTOWN, NY 12345 |
residential |
A residential customer with 1 account and 3 services (one water and one electric and one gas). |
222 MAIN ST BLDG, ANYTOWN, NY 12345 |
commercial |
A commercial customer with 2 accounts and 5 services (one water and three electric and one gas). |
| Account # | Last Bill Amount | Last Bill Date | Equivalent Test Scenario | Description |
|---|---|---|---|---|
111111111-1 |
100 |
2022-01-01 |
residential |
A residential customer with 1 account and 3 services (one water and one electric and one gas). |
222222222-2 |
200 |
2022-02-02 |
commercial |
A commercial customer with 2 accounts and 5 services (one water and three electric and one gas). |
| Test Account | Equivalent Test Scenario | Description |
|---|---|---|
test_residential |
residential |
A residential customer with 1 account and 3 services (one water and one electric and one gas). |
test_commercial |
commercial |
A commercial customer with 2 accounts and 5 services (one water and three electric and one gas). |
| Username | Password | Equivalent Test Scenario | Description |
|---|---|---|---|
test_residential |
test_residential |
residential |
A residential customer with 1 account and 3 services (one water and one electric and one gas). |
test_commercial |
test_commercial |
commercial |
A commercial customer with 2 accounts and 5 services (one water and three electric and one gas). |
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 |
|---|---|---|
DEMOUTILITY_ccccccccc |
Test Company | Link |