All calls included in the basic package are also included in the advanced package.
You can find the call examples here: User API - Basic package - Example calls
GET /administration/plants/{plantId}/address
Call
{{baseURL}}/api/v1/{{portal}}/administration/plants/{{plant}}/address
Parameter
GET https://api.enerest.world/api/v1/solarcompanyXYZ/administration/plants/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/address
baseURL =
https://api.enerest.world
Do NOT change that! It is always the same for every user
portal =
solarCompanyXYZ
Here you should add the first part of the portal domain
Without
.enerest.world
plant = i.e.
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Add your plants ID here
This ID can be found in
the
administration/plants
call orin the last part of the URL when you select the plant in the portal
i.e.
https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Result
GET /administration/plants/{plantId}/contacts
Call
{{baseURL}}/api/v1/{{portal}}/administration/plants/{{plant}}/contacts
Parameter
GET https://api.enerest.world/api/v1/solarCompanyXYZ/administration/plants/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/contacts
baseURL =
https://api.enerest.world
Do NOT change that! It is always the same for every user
portal =
solarCompanyXYZ
Here you should add the first part of the portal domain
Without
.enerest.world
plant = i.e.
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Add your plants ID here
This ID can be found in
the
administration/plants
call orin the last part of the URL when you select the plant in the portal
i.e.
https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Result
GET /datasource/plant/{plant}/inverters
Call
{{baseURL}}/api/v1/{{portal}}/datasource/plant/{{plant}}/components/{{date}}
Parameter
GET https://api.enerest.world/api/v1/solarCompanyXYZ/datasource/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/components/today
baseURL =
https://api.enerest.world
Do NOT change that! It is always the same for every user
portal =
solarCompanyXYZ
Here you should add the first part of the portal domain
Without
.enerest.world
plant = i.e.
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Add your plants ID here
This ID can be found in
the
administration/plants
call orin the last part of the URL when you select the plant in the portal
i.e.
https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
date =
today
The date can be either
today
orany Date
YYYY-MM-DD
Result
GET /visualization/kpi/{plantId}
Call
{{baseURL}}/api/v1/{{portal}}/datasource/plant/{{plant}}/epochrange?date={{date}}
Parameter
https://api.enerest.world/api/v1/solarCompanyXYZ/datasource/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/epochrange?date=2024-05-05
baseURL =
https://api.enerest.world
Do NOT change that! It is always the same for every user
portal =
solarCompanyXYZ
Here you should add the first part of the portal domain
Without
.enerest.world
plant = i.e.
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Add your plants ID here
This ID can be found in
the
administration/plants
call orin the last part of the URL when you select the plant in the portal
i.e.
https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
date =
2024-05-05
The date can be either
today
orany Date
YYYY-MM-DD