Description: Lakefront Utilities Inc. is a local distribution company (LDC) in Ontario, Canada.
Website: https://greenbutton.lakefrontutilities.com/
Utility ID:
LAKEFRONT
(this is the utility identifier you use in our API)
In order for you to request data from Lakefront Utilities Inc. customers, you must register with Lakefront Utilities Inc. as a third party company.
As part of their Green Button Connect My Data (GBCMD) program, Lakefront Utilities Inc. is using UtilityAPI's EE/DER Engagement Platform to allow third-party companies to request data access from Lakefront Utilities Inc. customers. Authorizations use the Green Button OAuth process, which means that third-parties have to be pre-registered with Lakefront Utilities Inc. so they can be assigned a client_id.
After registering with Lakefront Utilities Inc. as a third party, to request authorizations from Lakefront Utilities Inc. customers and test accounts, you can use any of these methods:
LAKEFRONT
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. Lakefront Utilities Inc. 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 Lakefront Utilities Inc. customers to verify their identity by providing their latest bill information. 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 (lastbill 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 (lastbill) is what you probably want to use for real Lakefront Utilities Inc. 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 |
---|---|---|---|
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 Lakefront Utilities Inc. 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 (lastbill or test).
Try one with your Lakefront Utilities Inc. data share link
(you aren't logged into an account that has a registered Lakefront Utilities Inc. client)
Account # | Last Bill Amount | Last Bill Date | Equivalent Test Scenario | Description |
---|---|---|---|---|
ALUI0000-02 |
300.00 |
2022-03-03 |
badlogin |
Simulate error where we couldn't find that customer. |
ALUI0000-00 |
140.00 |
2022-03-31 |
N/A |
A Lakefront Utilities Inc. residential customer. |
ALUI0000-01 |
1190.00 |
2022-03-23 |
N/A |
A Lakefront Utilities Inc. commercial customer. |
Test Account | Equivalent Test Scenario | Description |
---|---|---|
test_lakefront_residential |
residential |
A residential customer with 2 services (one electric and one water). |
test_lakefront_commercial |
commercial |
A commercial customer with 2 services (one electric and one water). |
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 |
---|---|---|
LAKEFRONT_ccccccccc |
Test Company | Link |