User API - Package description
- Stefanie Domzig
- Simon Schweda
All to the user assigned plants are available in the API, which means the user can activate the API and the data from his assigned plants is available via API calls.
In contrast to the Portal API, the User API only provides access to the plants assigned to a user. With the Portal API, you have access to all the portal's plants, regardless of whether these plants are assigned to the user or not. The User API can therefore be used to ensure that users are not given access to data that originates from ‘external’ plants.
The User can choose between the Basic Package and the Advanced Package. The packages differ in the scope of data that can be retrieved.
In the following pages the calls included in the packages are listed:
Differences in the range of functions between User API Basic and User API Advanced:
function | User API Basic | User API Advanced |
|---|---|---|
Request all historical data | ||
General plant information (i.e. adress, size, contact information) | ||
Overview of the plant components | ||
Production Values | ( ) - only total values on plant level | |
Consumption Values | ( ) - only total values on plant level | |
Battery storage values | ( ) - only total values on plant level | |
Inverter values | ||
MPP Tracker values | ||
Inverter String values | ||
Meter values | ||
plant KPIs | ||
Sensor values | ||
Fleets overview & fleet details |