The following are examples of the API calls available in the PortalAPI Advanced package.

All calls included in the basic package are also included in the advanced package. Only the additional calls available in the Advanced packs are listed below.

You can find the call examples for the Basic package here: Portal API - Basic package - Example calls

1 GET /administration/plants/{plantId}/address
2 GET /administration/plants/{plantId}/contacts
3 GET /administration/fleet/{fleetId}
4 GET /administration/fleet/{fleetId}/plants
5 GET /datasource/plant/{plant}/inverters
6 GET /visualization/kpi/{plantId}

`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 or
  - in 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

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "street": "Street",
    "houseNumber": "1",
    "postalCode": "00000",
    "city": "City",
    "country": "XX"
}

`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 or
  - in 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

[
    {
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "lastName": "Mustermann",
        "firstName": "Max",
        "company": "",
        "email": "max@mustermann.com",
        "phoneNumber": "",
        "mobilePhoneNumber": "",
        "address": {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "street": "",
            "houseNumber": "",
            "postalCode": "",
            "city": "",
            "country": "DE"
        },
        "comment": "",
        "role": null
    }
]

`GET /administration/fleet/{fleetId}`

Call

{{baseURL}}/api/v1/{{portal}}/administration/fleet/{{fleet}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/administration/fleet/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

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 or
  - in 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

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "ffufId": XXXX,
    "name": "fleet name",
    "fleetSize": 3242530,
    "description": "",
    "plantCount": 2,
    "plants": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "label": "4x Inverter, 4x Modulefield",
            "plantSize": 87090,
            "identifier": "XXXXXXXXXXXX",
            "address": {
                "street": "street",
                "houseNumber": "1",
                "postalCode": "XXXXX",
                "city": "city",
                "country": "DE"
            },
            "contacts": [
                {
                    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "lastName": "Mustermann",
                    "firstName": "Max",
                    "company": "",
                    "email": "mail@adress.com",
                    "phoneNumber": "",
                    "mobilePhoneNumber": "",
                    "address": {
                        "street": "",
                        "houseNumber": "",
                        "postalCode": "",
                        "city": "",
                        "country": "DE"
                    },
                    "comment": "",
                    "role": null
                }
            ]
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "label": "2x SCB, 4x Inverter",
            "plantSize": 1396800,
            "identifier": "XXXXXXXXXXXX",
            "address": {
                "street": null,
                "houseNumber": null,
                "postalCode": "XXXXX",
                "city": "city",
                "country": "CH"
            },
            "contacts": [
                {
                    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "lastName": "Mustermann",
                    "firstName": "Max",
                    "company": "",
                    "email": "max@solar-log.com",
                    "phoneNumber": null,
                    "mobilePhoneNumber": null,
                    "address": {
                        "street": null,
                        "houseNumber": null,
                        "postalCode": null,
                        "city": null,
                        "country": "DE"
                    },
                    "comment": "",
                    "role": null
                }
            ]
        }
}

`GET /administration/fleet/{fleetId}/plants`

Call

{{baseURL}}/api/v1/{{portal}}/administration/fleet/{{fleet}}/plants

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/administration/fleet/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/plants

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 or
  - in 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}}/inverters

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/datasource/plant/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/inverters

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 or
  - in 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 /visualization/kpi/{plantId}`

Call

{{baseURL}}/api/v1/{{portal}}/visualization/kpi/{{plant}}

Parameter

GET https://api.enerest.world/api/v1/solarCompanyXYZ/visualization/kpi/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

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 or
  - in 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

Online Help

Portal API - Advanced package - Example calls

Analytics

`GET /administration/plants/{plantId}/address`

Call

Parameter

Result

`GET /administration/plants/{plantId}/contacts`

Call

Parameter

Result

`GET /administration/fleet/{fleetId}`

Call

Parameter

Result

`GET /administration/fleet/{fleetId}/plants`

Call

Parameter

Result

`GET /datasource/plant/{plant}/inverters`

Call

Parameter

Result

`GET /visualization/kpi/{plantId}`

Call

Parameter

Result

Related content