User API - Advanced Paket - Beispiel Calls

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

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

Alle Aufrufe, die im Basic 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 Aufrufbeispiele für das Basic Paket hier.: https://solarlog.atlassian.net/wiki/spaces/SW/pages/269291454643

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-URLhinzufügen.

    • Ohne .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Fügen Sie hier die ID Ihrer Anlage hinzu

    • Diese ID finden Sie

      • im 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-URLhinzufügen.

    • Ohne .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Fügen Sie hier die ID Ihrer Anlage hinzu

    • Diese ID finden Sie

      • im 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 /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-URLhinzufügen.

    • Ohne .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Fügen Sie hier die ID Ihrer Anlage hinzu

    • Diese ID finden Sie

      • im 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",         "mpptrackers": [             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 8850,                 "name": "MPPT 1.1",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             },             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 13275,                 "name": "MPPT 1.2",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             }         ],         "moduleStrings": [],         "errorDetectionSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "active": 1,             "deviation": 10,             "notificationEmail": true,             "notificationSms": false,             "notificationRelais": false,             "notificationLed": false,             "production": 20,             "faultduration": 1800,             "faultDuration": 1800,             "alerts": 3,             "snow": false,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "componentCommunicationSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "faultduration": 1800,             "faultDuration": 1800,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "name": "WR 1",         "manufacturer": "Fronius",         "size": 22125,         "acPower": 20000,         "visualizationChannels": [             "ProdPac",             "ProdPacNorm",             "ProdPdc",             "ProdPdcNorm",             "ProdEtotal",             "ProdUac",             "TechAv"         ]     },     {         "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",         "mpptrackers": [             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 8620,                 "name": "MPPT 2.1",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             },             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 13275,                 "name": "MPPT 2.2",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             }         ],         "moduleStrings": [],         "errorDetectionSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "active": 1,             "deviation": 10,             "notificationEmail": true,             "notificationSms": false,             "notificationRelais": false,             "notificationLed": false,             "production": 20,             "faultduration": 1800,             "faultDuration": 1800,             "alerts": 3,             "snow": false,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "componentCommunicationSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "faultduration": 1800,             "faultDuration": 1800,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "name": "WR 2",         "manufacturer": "Fronius",         "size": 21895,         "acPower": 20000,         "visualizationChannels": [             "ProdPac",             "ProdPacNorm",             "ProdPdc",             "ProdPdcNorm",             "ProdEtotal",             "ProdUac",             "TechAv"         ]     },     {         "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",         "mpptrackers": [             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 8260,                 "name": "MPPT 3.1",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             },             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 12390,                 "name": "MPPT 3.2",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             }         ],         "moduleStrings": [],         "errorDetectionSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "active": 1,             "deviation": 10,             "notificationEmail": true,             "notificationSms": false,             "notificationRelais": false,             "notificationLed": false,             "production": 20,             "faultduration": 1800,             "faultDuration": 1800,             "alerts": 3,             "snow": false,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "componentCommunicationSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "faultduration": 1800,             "faultDuration": 1800,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "name": "WR 3",         "manufacturer": "Fronius",         "size": 20650,         "acPower": 20000,         "visualizationChannels": [             "ProdPac",             "ProdPacNorm",             "ProdPdc",             "ProdPdcNorm",             "ProdEtotal",             "ProdUac",             "TechAv"         ]     },     {         "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",         "mpptrackers": [             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 10030,                 "name": "MPPT 4.1",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             },             {                 "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",                 "moduleString": null,                 "moduleStrings": [],                 "moduleField": [],                 "size": 12390,                 "name": "MPPT 4.2",                 "visualizationChannels": [                     "ProdPdc",                     "ProdPdcNorm",                     "ProdUdc"                 ]             }         ],         "moduleStrings": [],         "errorDetectionSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "active": 1,             "deviation": 10,             "notificationEmail": true,             "notificationSms": false,             "notificationRelais": false,             "notificationLed": false,             "production": 20,             "faultduration": 1800,             "faultDuration": 1800,             "alerts": 3,             "snow": false,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "componentCommunicationSettings": {             "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",             "faultduration": 1800,             "faultDuration": 1800,             "periodstart": "11:00",             "periodStart": "11:00",             "periodend": "13:00",             "periodEnd": "13:00"         },         "name": "WR 4",         "manufacturer": "Fronius",         "size": 22420,         "acPower": 20000,         "visualizationChannels": [             "ProdPac",             "ProdPacNorm",             "ProdPdc",             "ProdPdcNorm",             "ProdEtotal",             "ProdUac",             "TechAv"         ]     } ]

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-URLhinzufügen.

    • Ohne .enerest.world

  • plant = i.e. XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

    • Fügen Sie hier die ID Ihrer Anlage hinzu

    • Diese ID finden Sie

      • im 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

Wird in kürze aktualisiert von @Stefanie Domzig