Page Comparison

...

• Der Endpunkt REST API URL https://apibridge.elpro.cloud

  • Das API-Token wird von ELPRO bereitgestellt

• Für Entwickler ist die technische Spezifikation von OpenAPI als Swagger UI verfügbar https://apibridge.elpro.cloud/swagger

3.1 Datensätze und allgemeines Abfrageschema

...

Geben Sie Ihren API-Autorisierungscode im Anfrage-Header als Schlüssel und Wert an: 

Im Falle eines Fehlens oder einer Nichtübereinstimmung wird eine Fehlermeldung mit dem HTTP-Status 401 "Unauthorized" zurückgegeben.

...

Die abgerufenen Daten fallen in den Bereich der Organisation des authentifizierten API-Benutzers. Sie werden mit dem HTTP-Statuscode 200 (Success) zurückgegeben.

3.1.3 Http-Fehler-Codes

3.2 Konfigurations-API

Die REST-Schnittstelle bietet einen sehr einfachen Endpunkt für die Konfiguration von LIBERO Gx-Geräten.

Konfigurationsvorlage erstellen und hochladen

• Verwenden Sie den Wizard in elproCLOUD, um eine Konfigurationsvorlage für einen LIBERO Gx zu erstellen

• Wählen Sie den richtigen LIBERO Gx-Typ (die ersten drei Ziffern der Seriennummer sind wichtig)

• Füllen Sie die Formulare des Wizard aus, bis Sie die Übersichtsseite erreicht haben

  • Alt+Klick auf die Schaltfläche "Sensor kaufen und starten".

  • Ein Dateidownload wird angezeigt

  • Speichern Sie die Datei unter einem passenden Namen (z.B. LIBERO_GH_longlive_freezer.json)

• Verwenden Sie den Endpunkt POST /api/v1/Templates, um den Inhalt der gespeicherten Konfigurations-JSON-Datei hochzuladen

  • Wichtig: Die Konfiguration muss JSON-escaped sein. Tun Sie dies programmatisch oder verwenden Sie ein Online-Tool

  • Das Anfrageobjekt wird in der Swagger UI beschrieben

• Optional: Verwenden Sie den Endpunkt GET /api/v1/Templates, um alle verfügbaren Vorlagen aufzulisten

Konfigurieren Sie die Vorlagen

• Verwenden Sie den Endpunkt PUT /api/v1/Device/{deviceSerialNumber} zur Konfiguration der Geräte

  • Ein Aufruf pro Gerät, verwenden Sie ein Skript, um diesen Prozess zu automatisieren

  • Drei mögliche Nutzdaten, die durch $type angegeben werden

    • Weitere Informationen zu den spezifischen Objekten finden Sie in der Swagger UI

    • DeviceConfigurationRequestByTemplateId und DeviceConfigurationRequestByTemplateName können zur Konfiguration eines Geräts verwendet werden

      • Optional: Bereitstellung von Metadaten, siehe Swagger UI für weitere Informationen zu Platzhaltern

    • DeviceConfigurationRequestClearPending kann verwendet werden, um eine ausstehende Konfiguration für Geräte zu löschen, die noch nicht mit der Organisation gepaart worden sind

3.3 Version der REST-API

Für die REST-API ist ein Versionierungsmechanismus implementiert.

...

Die Warteschlangen-Nachrichten haben folgende grundlegende Nutzdaten im JSON-Format:

4.2 Nachrichtentyp

Jeder Typ repräsentiert eine spezielle JSON-Nutzlast innerhalb des Data JSON-Objekts. So weiß ein Verbraucher, welches Datenmodell verwendet wird.

...

Die Daten-Nutzdaten sind für jeden Typ unterschiedlich.

4.3.1 Messwerte

4.3.1.1 Beispiel-Messungen

...

{
    "type": "eapi_measurement_new",
    "data": {
	    "sensorId": "5368"
		"deviceId": "951FF00000340",
        "timeStamp": "2022-10-11T16:21:27+00:00",
        "value": 24.6		"error": "Short Circuit",
		"status": 0,
        "unit": "°C",
        		"unitType": “temperature",
        "deviceId		"value": "951FF00000340",
        "sensorId": "5368"  24.6,
		"tiltAngle": 2.4,
    }
}

4.3.2 GeoDaten

4.3.2.1 Beispiel GeoDaten

...

{
    "type": "eapi_geodata_new",
    "data": {
        "timeStamp": "2022-10-11T15:21:24+00:00",
        "latitude": 47.19999075,
        "longitude": 9.50875282,
        "accuracy": 2316,
        "deviceId": "951FF00000340",
        "sensorId": "5369"
    }
}

4.3.3 Occurence

4.3.3.1 Beispiel Occurence

...

{
    "type": "eapi_occurrence_new",
    "data": {
        "timeStamp": "2022-10-11T15:21:24+00:00",
        "typeName": "LoggerStatusChange",
        "previousState": "Start",
        "newState": "LogDelayed",
        "deviceId": "951FF00000340",
        "sensorId": "5369"
    }
}

4.3.4 Abweichung

4.3.4.1 Beispiel Abweichung aufgetreten

...