Ebeco Open API
Auf dieser Seite finden Sie Informationen und Zugang zu unserer Open API. Diese Dienstleistung steht Ihnen zur Verfügung, damit Sie Ihre eigene intelligente Lösung entwickeln können.
Nutzungsbedingungen
Das über die Ebeco Open API bereitgestellte Material darf nicht zur Verbreitung von bösartigem Code oder in einer Weise verwendet werden, die die Marke Ebeco schädigen könnte. Wir möchten Sie außerdem bitten, Ebeco als Quelle anzugeben.
Erste Schritte
Mit der Ebeco API können Sie die Fußbodenheizung in allen Anlagen steuern, in denen der EB-Therm 500 Thermostat zusammen mit dem EB-Connect WiFi-Modul vorhanden ist.
Um unsere offene API zu nutzen, gehen Sie wie folgt vor:
- Installieren Sie das EB-Connect WiFi-Modul im EB-Therm 500 Thermostat
- Wählen Sie ein Netzwerk und geben Sie das Kennwort für Ihr Netzwerk im Thermostat ein
- Laden Sie Ebeco Connect aus dem App Store oder von Google Play herunter
- Folgen Sie den Anweisungen in der App, um ein Konto zu erstellen
- Verwenden Sie die nachstehende Dokumentation, um Ihren eigenen Dienst oder Ihre eigene Anwendung zu erstellen.
Technische Daten
Die API von Ebeco ist eine REST-API, die JSON erwartet und zurückgibt.
Beschränkungen
Um einen Missbrauch der API zu vermeiden, wird die Anzahl der Anfragen auf der Ebene der IP-Adressen gedrosselt. In einem Zeitraum von 10 Sekunden dürfen insgesamt 10 Anfragen und in einem Zeitraum von 60 Sekunden insgesamt 30 Anfragen gesendet werden. Wenn man die Anzahl der Anfragen überschreitet, gibt die API für den Rest des oben genannten Zeitraums „HTTP 429 Too many requests“ zurück. Nach Ablauf der Frist beginnt die API wieder zu reagieren.
Bitte beachten Sie! Die Anzahl der zulässigen Anfragen kann von Ebeco jederzeit und ohne Vorankündigung geändert werden.
Authentifizierung
Die Authentifizierung bei der Ebeco-API erfolgt mit einem Bearer Token, das über /api/TokenAuth/Authenticate erworben wird. Die Benutzernamen und Kennwörter sind dieselben, die auch in der Ebeco Connect-App verwendet werden. In den folgenden Beispielen verwenden wir Postman für Anfragen.
Der Parameter Abp.TenantId sollte immer im Header übergeben und auf 1 gesetzt werden.
Benutzername und Kennwort werden dann als POST-Anfrage an /api/TokenAuth/Authenticate gesendet.
Der in der Antwort zurückgegebene Parameter accessToken wird dann zur Authentifizierung bei der Ebeco-API verwendet.
Beispiel:
Wir senden eine GET-Anfrage an /api/services/app/Devices/GetUserDevices und authentifizieren den Header mit „Bearer <accessToken>“. Es wird eine JSON-Liste der Thermostate des angemeldeten Benutzers zurückgegeben.
Eine vollständige Referenz der Methoden und Parameter finden Sie in unserer Swagger-Dokumentation unter ebecoconnect.com/swagger