REST-API und Webhooks für Ihre Modbus-Daten
Holen Sie jeden Wert, den Ihre Gateways auslesen, in Ihre eigene Software. Die API ist in jeder Lizenz enthalten.
AnfrageGET
curl https://api.modbuscloud.com/v1/devices/3f9c2a71/registers \
-H "Authorization: Bearer mlk_…"Antwort200 OK
{
"data": [
{
"modbus_device_name": "Eastron SDM630",
"name": "Spannung L1",
"unit": "V",
"latest_value": 231.4,
"latest_ts": "2026-10-05T14:02:00.000Z"
},
{
"modbus_device_name": "Eastron SDM630",
"name": "Gesamtleistung",
"unit": "W",
"latest_value": 4180.6,
"latest_ts": "2026-10-05T14:02:00.000Z"
}
]
}- Preis
- In jeder Lizenz
- Verlauf
- 12 Monate
- Limit
- 100 Anfragen pro Minute
- Spezifikation
- OpenAPI 3.1
- Hosting
- Irland (EU)
Was Sie über die API abrufen
Gateways und Geräte
Jedes Gateway mit Status, 4G-Signal und IP-Adressen, dazu die Modbus-Geräte dahinter.
Register mit dem letzten Wert
Bereits in die Einheit umgerechnet, die Sie im Portal sehen. Der Rohwert wird mitgeliefert.
Verlauf
Bis zu zwölf Monate zurück. Sie rufen ihn seitenweise ab und halten so eine vollständige Kopie in Ihrer eigenen Datenbank.
Alarme
Jeder Alarm mit seinem Status, von ausgelöst bis erledigt.
Jedes System, das HTTPS-Anfragen senden kann, lässt sich anbinden. So landen die Werte in einem BI-Dashboard, einem ERP-System, einem Data Warehouse, einer Gebäudeleittechnik oder Ihrer eigenen Software.
Webhooks, wenn ein Gateway ausfällt oder ein Alarm auslöst
Ihr System erfährt es, wenn ein Gateway offline geht oder wieder online ist, wenn ein Alarm auslöst, wenn der Wert wieder normal ist und wenn jemand einen Alarm quittiert oder erledigt.
Jeder Webhook ist nach der offenen Spezifikation Standard Webhooks signiert. Für jede gängige Programmiersprache gibt es eine Bibliothek, die die Signatur prüft.
Ist Ihr Empfänger kurz nicht erreichbar, versuchen wir es erneut, bis zu sechsmal innerhalb von gut sieben Stunden. Jede Wiederholung trägt dieselbe ID, so verarbeiten Sie nichts doppelt. Eine Testnachricht senden Sie aus dem Portal.
| Ereignis | Wann |
|---|---|
| device.offline | Ein Gateway ist offline |
| device.online | Ein Gateway ist wieder online |
| alert.triggered | Ein Alarm löst aus |
| alert.returned | Der Wert ist wieder normal |
| alert.acknowledged | Jemand quittiert den Alarm |
| alert.resolved | Der Alarm ist erledigt |
| automation.triggered | Eine Automatisierung führt eine Aktion aus |
Testen ohne Konto
In der Dokumentation steht ein Sandbox-Schlüssel für unser Demo-Konto, das Portal eines fiktiven Installationsbetriebs.
Damit führen Sie jeden Aufruf in der Dokumentation sofort aus, ohne Konto. Die Sandbox hat nur Lesezugriff.
Mit der Sandbox testenSpezifikationen der API
| Anfragen | |
|---|---|
| Adresse | api.modbuscloud.com/v1 |
| Format | REST über HTTPS, Antworten in JSON |
| Spezifikation | OpenAPI 3.1, in Postman importierbar oder zum Generieren eines Clients |
| Schlüssel | Pro Organisation, mit Scopes. Ein Schlüssel wird nur einmal angezeigt, kann ablaufen und lässt sich jederzeit widerrufen |
| Limit | 100 Anfragen pro Minute pro Schlüssel, mit dem verbleibenden Kontingent in jeder Antwort |
| Fehlermeldungen | Problem Details (RFC 9457) mit festem Fehlercode und Request-ID |
| Schreiben | Das Schreiben von Registern über die API schalten wir auf Anfrage frei |
| Daten | |
| Ressourcen | Gateways mit ihren Modbus-Geräten, Register, Verlauf und Alarme |
| Werte | In die Einheit aus dem Portal umgerechnet, mit dem Rohwert |
| Verlauf | Bis zu 12 Monate. Jeder gelesene Wert, standardmäßig einer alle fünf Minuten und höchstens einer pro Minute |
| Abruf | Seitenweise mit einem Cursor, bis zu 1000 Messwerte pro Seite |
| Webhooks | |
| Ereignisse | Gateway offline und wieder online, Alarm ausgelöst, Wert wieder normal, Alarm quittiert und erledigt, Automatisierung ausgeführt |
| Signatur | Standard Webhooks (HMAC-SHA256) |
| Wiederholung | Bis zu sechsmal innerhalb von gut sieben Stunden, mit derselben ID |
| Allgemein | |
| Hosting | API und Datenbank in Irland (EU) |
| Preis | In jeder Lizenz enthalten, ohne Kosten pro Anfrage |
| Sandbox | Demo-Konto, ohne eigenes Konto, 60 Anfragen pro Minute |
Selbst sehen, wie es funktioniert?
