REST-API
Mit der Sensorbee-REST-API rufen Sie Daten ab und ändern Einstellungen bei Bedarf. Nutzen Sie sie für historische Auswertungen, regelmäßige Berichte, Dashboards, die nach Zeitplan abrufen, oder Backoffice-Integrationen ohne Echtzeit-Push.
Für Echtzeit-Weiterleitung verwenden Sie stattdessen die Push-API.
Testen Sie die Endpunkte interaktiv unter api-docs.sensorbee.com.
Authentifizierung
Jede Anfrage benötigt einen API-Schlüssel, der im HTTP-Header apiKey gesendet wird. Den Schlüssel erzeugen Sie im Sensorbee-Cloud-Portal.
Endpunkte
GET /report – historische Daten
Historische Sensordaten eines Geräts über einen Zeitraum abrufen.
- ·URL –
https://console.sensorbee.com/api/report - ·Methode –
GET - ·Header –
apiKey: <Ihr-API-Schlüssel>
Abfrageparameter:
| Parameter | Beschreibung |
|---|---|
installationid | Installations-ID des Geräts. |
baseunitid | ID der Basiseinheit / Seriennummer des Geräts. Alternative zu installationid. |
from | Beginn des Zeitraums – YYYY-MM-DD hh:mm:ss. |
to | Ende des Zeitraums – YYYY-MM-DD hh:mm:ss. |
Rückgabe – JSON im Format der Smart-City-Vorlage.
GET /device – Geräteinformationen
Identität, Status und Konnektivität eines Geräts vom LwM2M-Server abrufen.
- ·URL –
https://console.sensorbee.com/api/device - ·Methode –
GET - ·Header –
apiKey: <Ihr-API-Schlüssel>
Abfrageparameter:
| Parameter | Beschreibung |
|---|---|
type | Auf get_info setzen. |
baseunitid | Vierstellige Seriennummer des Geräts. Eine dieser drei Kennungen ist erforderlich. |
installationid | Dem Gerät zugewiesene Installations-ID. |
endpoint_name | LwM2M-Endpoint-Name des Geräts. |
Rückgabe – JSON mit den Abschnitten information, status und connectivity. Beispiel:
POST /polling – Abfrageintervall ändern
Das Abfrageintervall eines Geräts programmatisch ändern. Der neue Wert wird beim nächsten Meldezyklus wirksam, nicht sofort.
- ·URL –
https://console.sensorbee.com/api/polling - ·Methode –
POST - ·Header –
apiKey: <Ihr-API-Schlüssel>
Abfrageparameter:
| Parameter | Beschreibung |
|---|---|
interval | Neues Abfrageintervall in Sekunden. |
baseunitid | Vierstellige Seriennummer des Geräts. Eine dieser drei Kennungen ist erforderlich. |
installationid | Installations-ID. |
endpoint_name | LwM2M-Endpoint-Name. |
Rückgabe – Bestätigung, dass die Anfrage angenommen wurde; die Änderung wird für den nächsten Abfragezyklus vorgemerkt:
