Portal API - Advanced package - Beispiel Calls

Owned by Stefanie Domzig
Last updated: Nov 05, 2024
14 min read

Die folgenden sind Beispiele für die API-Aufrufe, die im Portal API Advanced-Paket verfügbar sind.

Alle Aufrufe, die im Basis-Paket enthalten sind, sind auch im Advanced-Paket enthalten. Nur die zusätzlichen Aufrufe, die in den Advanced-Paketen verfügbar sind, sind unten aufgeführt.

Sie finden die Beispielaufrufe für das Basis-Paket hier.: Portal API Basic - Beschreibung des Paketumfangs

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

    • Ändern Sie das NICHT! Das ist für jeden Benutzer immer dasselbe

  • portal = solarCompanyXYZ

    • Hier sollten Sie den ersten Teil der Portal-URL hinzufügen

    • Ohne .enerest.world

  • plant = Bsp.: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Anlagen ID eingeben

    • Die Anlagen ID kann hier gefunden werden

      • über den administration/plants call oder

      • im letzten Teil der URL, wenn Sie die Anlage im Portal auswählen

        • Bsp.: https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Ergebnis

{     "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

    • Ändern Sie das NICHT! Das ist für jeden Benutzer immer dasselbe

  • portal = solarCompanyXYZ

    • Hier sollten Sie den ersten Teil der Portal-URL hinzufügen

    • Ohne .enerest.world

  • plant = Bsp.: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Anlagen ID eingeben

    • Die Anlagen ID kann hier gefunden werden

      • über den administration/plants call oder

      • im letzten Teil der URL, wenn Sie die Anlage im Portal auswählen

        • Bsp.: https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Ergebnis

[     {         "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

    • Ändern Sie das NICHT! Das ist für jeden Benutzer immer dasselbe

  • portal = solarCompanyXYZ

    • Hier sollten Sie den ersten Teil der Portal-URL hinzufügen

    • Ohne .enerest.world

  • plant = Bsp.: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Anlagen ID eingeben

    • Die Anlagen ID kann hier gefunden werden

      • über den administration/plants call oder

      • im letzten Teil der URL, wenn Sie die Anlage im Portal auswählen

        • Bsp.: https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Ergebnis

{     "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

    • Ändern Sie das NICHT! Das ist für jeden Benutzer immer dasselbe

  • portal = solarCompanyXYZ

    • Hier sollten Sie den ersten Teil der Portal-URL hinzufügen

    • Ohne .enerest.world

  • plant = Bsp.: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Anlagen ID eingeben

    • Die Anlagen ID kann hier gefunden werden

      • über den administration/plants call oder

      • im letzten Teil der URL, wenn Sie die Anlage im Portal auswählen

        • Bsp.: https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Ergebnis

 

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

    • Ändern Sie das NICHT! Das ist für jeden Benutzer immer dasselbe

  • portal = solarCompanyXYZ

    • Hier sollten Sie den ersten Teil der Portal-URL hinzufügen

    • Ohne .enerest.world

  • plant = Bsp.: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Anlagen ID eingeben

    • Die Anlagen ID kann hier gefunden werden

      • über den administration/plants call oder

      • im letzten Teil der URL, wenn Sie die Anlage im Portal auswählen

        • Bsp.: https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Ergebnis

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

    • Ändern Sie das NICHT! Das ist für jeden Benutzer immer dasselbe

  • portal = solarCompanyXYZ

    • Hier sollten Sie den ersten Teil der Portal-URL hinzufügen

    • Ohne .enerest.world

  • plant = Bsp.: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Anlagen ID eingeben

    • Die Anlagen ID kann hier gefunden werden

      • über den administration/plants call oder

      • im letzten Teil der URL, wenn Sie die Anlage im Portal auswählen

        • Bsp.: https://solarCompanyXYZ.enerest.world/administration/plants/detail/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Result