Now you understand the context and the required energy data input for the Customer Engagement service, this guide will show you how to make your first API call.
To get started, request
client_secretfor your client to connect with your dedicated customer instance of the NET2GRID platform. Separate
API keysare needed for the production and for the staging environment.
Customer API-docs / Postman collection
Request the URL that will return the OpenAPI Specifications of the CE-API endpoints that are available in your dedicated customer instance of the NET2GRID Platform in JSON format. You can use the returned values of this URL to import the CE-API endpoint definitions in Postman or any other HTTP client of your preference.
Note that the endpoints available on your platform may slightly differ from the endpoints that are listed in the Readme API reference depending on the version of the CE-API that has been deployed and the configuration of your platform.
As described in User registration, before you can issue API requests for a user, the user needs to be provisioned, registered and authenticated.
In order to ensure that you only onboard known and legitimate users on the platform, NET2GRID provisioning is set up from a B2B perspective, using your CRM, Customer Care or customer portal as a source. To integrate with such a system, use the NET2GRID Account Management API.
Before you have set up the integration and to start with the CE-API in a play ground scenario NET2GRID can provision a view test users for you via the Account Management API.
The provisioned users need to be registered by entering a password via the POST /v2/registration/no-gateway call.
Finally, for a user to perform any call on the platform, he or she needs to be authenticated via the token endpoint as described in the Authentication users guide. This call returns a temporary
access token of type
bearer token that should be used in the authorization header of each call.
Updated 9 months ago