Integration Steps

Endpoint	Benefit	Notes
bankId or openId	Enables a User to verify their identity and login to the app.	This step is needed to confirm the identity of the person or company attempting to login and establish a scope for the data they can view.
oauth or API Key	Enables access to the entireData Layer.	Any of the supported authorization flows that result in a type of `access_token` for subsequent api calls is acceptable. Refresh tokens must be able to be used outside of User interactions. API Key is the easiest to manage and recommended for Organisations who support its use.
Search for account	Fetch the `accountId`	Use the `personalNumber` as the `ssn` from a BankId authorization flow after a `completed` status value shows up from BankId collect. Use the `email` after a successful oauth or openId flow.
Get account	Populates data in the User profile view.	Confirms the `accountId`is correctly attributed to the User.
Get user roles for account	Enable user management within an Account.	Account Owners can manage Guests and other Account Owners.
Get locations	Enables Services provided by the Organisation to be viewed by the Account Owner. Enables Location data to viewed by Users.
Get agreements	Enables Agreements for a single Service to be viewed by the Account Owner.
Get account invoices	Enables Invoice data for all Services to be viewed by the Account Owner.
Get measurements for service	Enables Measurements viewing by Users.	Inside each object in the services array from Get locations there is a `measurementId` for each Service used in requesting Get measurements for service.
Get products	Enables Products for each Service to be viewed by Account Owners.	Inside each object in the services array from Get locations there is an `id` for each Service used as the `serviceId`in requesting Get products.
Get cost for a service	Enables the Cost for each Service to be viewed by Accounts.	Inside each object in the services array from Get locations there is a `costId` for each Service used in requesting Get cost for a service.
Get account invoice url or Get account invoice stream	Enables Invoice PDF's to be viewed by the Account Owner.	Use a `invoiceId` from the response Get account invoices.
Update user	Enables a User to update their `phoneNumber`and `emailAddress`via the app.	Inside each object in the response from Get user roles for account there is a `user` object with an `id`used as the `userId`in requesting Update user.
Add User to account	Enables an Account Ownerto add new Guests to their account.
Report Event	Allows Bright Energy to report Events back to the Organisation.	Use Search for account to get the `accountId` used in requesting Report Event.

What’s Next