Onboarding process

In this section we will describe the onboarding process for end users in NET2GRID Insight Platform and define how the state of a end-user account impacts the availability of the Customer Engagement API endpoints.

The onboarding process of end-users in NET2GRID Insight consists of 3 steps:

Provisioning an account via the B2B Account Management Interface
Completing the registration of the end-user as described in the User registration section
Activating the account of the end-user by setting up the infrastructure for the user to receive measurements associated to their account as described in the Authenticating users section.

Once the onboarding process is complete the end-user will be able to use all the CE-API endpoints that are relevant to the services that have been enabled in your dedicated customer instance of NET2GRID Insight Platform.

We are now going to describe how the state of the end-user in the onboarding process will impact the availability of the CE-API endpoints.

Provisioned

In this state an end-user is "known" to the NET2GRID Insight Platform so that the registration process can be initiated.

Registered

In this state the registration process of the end-user has been completed and the user can authenticate in the CE-API.

Only some endpoints are available in this state of the user. They are mainly the endpoints that will need to be triggered to activate the end-user but also endpoints that describe the state of the end-user so that the app can identify that the next actions should be targeted to activating the account. These endpoints are described in the Activating users section.

Active

In this state the end-user account is ready to receive or started to already receive energy measurements. This is the dependency for most of the endpoints on CE-API to work.

Once a user reaches the "active" state then they can proceed with Setting up end-user profile and preferences