Description: Southwestern Electric Power Company is a utility services company serving the southwestern United States.
Website: https://greenbutton.swepco.com/
Utility ID:
SWEPCO
(this is the utility identifier you use in our API)
In order for you to request data from Southwestern Electric Power Company customers, you must register with Southwestern Electric Power Company as a third party company.
As part of their Green Button Connect My Data (GBCMD) program, Southwestern Electric Power Company is using UtilityAPI's EE/DER Engagement Platform to allow third-party companies to request data access from Southwestern Electric Power Company customers. Authorizations use the Green Button OAuth process, which means that third-parties have to be pre-registered with Southwestern Electric Power Company so they can be assigned a client_id.
After registering with Southwestern Electric Power Company as a third party, to request authorizations from Southwestern Electric Power Company customers and test accounts, you can use any of these methods:
SWEPCO
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. Southwestern Electric Power Company 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 by default allow Southwestern Electric Power Company customers to verify their identity through Single Sign-On (SSO). 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 (sso or test) they want their OAuth authorize request to default to by their preferred authentication choice to the scope string. In general, you'll probably only find this useful for automated testing with test accounts, since the default (sso) is what you probably want to use for real Southwestern Electric Power Company customers.
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 |
---|---|---|---|
test |
Yes | Authenticate using a specific test scenario. | auth-test-test_residential |
Since the Southwestern Electric Power Company 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 (sso or test).
Try one with your Southwestern Electric Power Company data share link
(you aren't logged into an account that has a registered Southwestern Electric Power Company client)
Test Account | Equivalent Test Scenario | Description |
---|---|---|
test_residential |
residential |
A residential customer with 1 account and 1 electric service. |
test_commercial |
commercial |
A commercial customer with 2 accounts and 2 services (two electric). |
test_badlogin |
badlogin |
Simulate error where we couldn't find that customer. |
Username | Password | Equivalent Test Scenario | Description |
---|---|---|---|
test_residential |
test_residential |
residential |
A residential customer with 1 account and 1 electric service. |
test_commercial |
test_commercial |
commercial |
A commercial customer with 2 accounts and 2 services (two electric). |
test_badlogin |
test_badlogin |
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 |
---|---|---|
SWEPCO_ccccccccc |
Test Company | Link |