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. 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.
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 historical data |
|
|
Plant Values (e.g. total production of all inverters) |
|
|
Inverter |
|
|
MPP Tracker |
|
|
Inverter Strings |
|
|
Production Values |
|
|
Consumption Values |
|
|
Battery storages |
|
|
Meters |
|
|
KPIs |
|
|
Sensor Values |
|
|
Plant adress & contacts |
|
|
Fleets overview & fleet details |
|
|
Component Events |
|
|
Query periods and data resolution
Depending on the query period or the API call itself, the data is returned in different resolutions.
The data resolutions for the query periods are shown below.
query period | data resolution |
|---|---|
day | 5 minute values |
month | daily values |
year | monthly values |
total (entire life time) | yearly values |
individual (from date - to date) | 5 minute values |