Connect and Link Sequence
Steps
Show available vendors to user
To inform your user which energy brands or manufacturers are currently supported, the endpoint All available vendors helps you prepare the vendor selection screen. You can use this list as the basis for offering users a choice of which vendors to connect to.
Create connect session and redirect user
The connect session is initiated by redirecting your user to the URL provided by calling, for example, Connect session for vehicle (the specific endpoint depends on the device type you want to connect). The user will be redirected to the vendor’s official identity provider (IDP) and will connect their vendor account to the Energy Hub Alliance.
When the connection is successful, the redirect will include the vendorAccountId as a parameter in the redirect URL. This vendorAccountId is required for the following steps to link the devices associated with the vendor account.
The connect session only connects the user’s vendor account. To link the devices from that vendor account, continue with the next two steps.
Let user pick which devices to connect
A connected vendor account can include several energy devices. To retrieve a list of devices connected to the vendor account, use, for example, List vehicles from vendor (the specific endpoint depends on the device type you want to connect).
Link devices to the Energy Hub Alliance
As a final step, once the user or application has decided which devices should be added, Link vehicles links the selected devices to the platform. All set! The items are now linked to the Energy Hub Alliance and can be accessed through the API. Data streaming should also begin for the linked devices.
Sequence Diagram (simplified)
Connect and Link Sequence
Steps
Show available vendors to user
To inform your user which energy brands or manufacturers are currently supported, the endpoint All available vendors helps you prepare the vendor selection screen. You can use this list as the basis for offering users a choice of which vendors to connect to.
Create connect session and redirect user
The connect session is initiated by redirecting your user to the URL provided by calling, for example, Connect session for vehicle (the specific endpoint depends on the device type you want to connect). The user will be redirected to the vendor’s official identity provider (IDP) and will connect their vendor account to the Energy Hub Alliance.
When the connection is successful, the redirect will include the vendorAccountId as a parameter in the redirect URL. This vendorAccountId is required for the following steps to link the devices associated with the vendor account.
The connect session only connects the user’s vendor account. To link the devices from that vendor account, continue with the next two steps.
Let user pick which devices to connect
A connected vendor account can include several energy devices. To retrieve a list of devices connected to the vendor account, use, for example, List vehicles from vendor (the specific endpoint depends on the device type you want to connect).
Link devices to the Energy Hub Alliance
As a final step, once the user or application has decided which devices should be added, Link vehicles links the selected devices to the platform. All set! The items are now linked to the Energy Hub Alliance and can be accessed through the API. Data streaming should also begin for the linked devices.