Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. 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.

...

Differences in the range of functions between User API Basic and User API Advanced:

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(error)(error)(error)(tick)

function

User API Basic

User API Advanced

Request all historical data

(tick)

(tick)

Plant Values (e.g. total production of all invertersGeneral plant information (i.e. adress, size, contact information)

(tick)

(tick)

Inverter

Overview of the plant components

(tick)

(tick)

MPP Tracker

Production Values

( (tick) ) - only total values on plant level

(tick)

Inverter Strings

Consumption Values

( (tick) ) - only total values on plant level

(tick)

Production ValuesBattery storage values

( (tick) ) - only total values on plant level

(tick)

Consumption ValuesInverter values

(error)

(tick)

Battery storagesMPP Tracker values

(error)

(tick)

MetersInverter String values

(error)

(tick)

KPIsMeter values

(error)

(tick)

Sensor Valuesplant KPIs

(error)

(tick)

Plant adress & contacts

Sensor values

(error)

(tick)

Fleets overview & fleet details

(error)

(error)

Component Events

(tick)

(tick)

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.