Introduction

Welcome to the developer guides of the Customer Engagement API of NET2GRID EnergyAI.

The NET2GRID customer engagement service is developed for customers, such as energy retailers, OEMs and other service providers that want to offer their customers insights in the energy behaviour of their household. The customer engagement API offers a wide range of endpoints for App Developers of the service providers to create or enrich energy apps for their particular use case.

Prerequisites

Before being able to integrate with NET2GRID EnergyAI the customer onboarding phase should have been completed. This means the following information should now be available:

The hostname that points to the dedicated EnergyAI instance;
Credentials to connect with the dedicated EnergyAI instance, consisting of a client_id and client_secret;

Terminology

These guides use some basic terminology which is explained in the table below.

Word	Explanation
Customer	You, the service provider or the platform that is integrating with NET2GRID Insight Platform.
Account Management API	NET2GRID API that is used for provisioning users and tariffs from a B2B perspective. Usually the Account Management API is invoked from a CRM or other Customer Care system with customer account detail records.
CE-API	Short for Customer Engagement API.
CSD	Current Summation Delivered. This meter value shows the amount of energy (in watt-hours) delivered from the grid to the household.
CSR	Current Summation Received. This meter value shows the amount of energy (in watt-hours) that is delivered back from the household to the grid.
Customer Engagement API	The NET2GRID API targeted at app developers of customers to provide energy insights to the users of their apps.
Channel	A media source through which notifications are sent to the user. Currently supported channels are email, mobile push notifications, in-app inbox and REST API notifications.
EV	Electric Vehicle.
EUI	Extended Unique Identifier. In this guide this refers to a value uniquely identifying the SmartBridge device.
Feedin	Synonymous to Injection.
Household	A home residence with its occupants.
Injection	The amount of electricity (in kWh) that has been injected back into the grid, e.g. via solar production. This is calculated via the meter CSR value (how much electricity the electricity company has received from the household).
Installation	The combination of meters, appliances and properties that describe a household.
Instantaneous Demand (IDD)	This meter value shows the amount of power that is used in the household.
labelpartner	A group level within the customer account on a single platform to manage the service for different labels, subsidiaries, countries etc.
NET2GRID EnergyAI	The NET2GRID platform hosted on a dedicated customer AWS account that facilitates all services described in this API.
Non-Intrusive Load Monitoring (NILM)	The science of disaggregating electricity consumption from real-life measurements at the appliance/activity level.
Notification topic	A predefined category referring to a set of notifications which can be muted or unmuted by end-users.
Offtake	The amount of electricity (in kWh) that has been taken off the grid. This calculated via the meter CSD value (how much electricity the electricity company has delivered to the household)
Power (P)	Electrical power is the rate at which electrical energy is transferred by an electric circuit. The SI unit of power is the watt, one joule per second.
PV	Photovoltaic. Photovoltaic systems, like solar panels which convert sunlight into electrical energy.
Real-time data	Energy measurements derived from NET2GRID hardware, usually with a high data granularity of 1-10 seconds and near real-time availability.
SmartBridge	A hardware device developed by NET2GRID that can be connected to a smart meter to provide real-time data to the NET2GRID Insight Platform via the WiFi of the household.
Smart Meter data (Deprecated term)	Energy measurements derived from Meter Data Management systems or data hubs, usually with a granularity of 15-160 minutes and day before availability.
SDP	Service Delivery Platform. This is the former name of the Customer Engagement API (CE API)
User	The users consuming the information provided by your platform.