Zum Inhalt

API-Referenz

Die WattWächter REST API ist unter http://ww.local/api/v1/ erreichbar und bietet vollen Zugriff auf Gerätedaten, Einstellungen und Steuerungsfunktionen.

Authentifizierung

Die API verwendet Bearer Tokens im Authorization-Header:

Authorization: Bearer DEIN_TOKEN

Es gibt zwei Token-Stufen:

  • READ Token — Daten lesen (History, Status, Einstellungen anzeigen)
  • WRITE Token — Einstellungen ändern, OTA starten, Reboot auslösen

Token erneuern

Tokens können über einen zweistufigen Prozess erneuert werden:

  1. POST /api/v1/auth/tokens/generate — Generiert neue Tokens (noch nicht aktiv)
  2. POST /api/v1/auth/tokens/confirm — Aktiviert die neuen Tokens (innerhalb von 60 Sekunden)

Dieser Zwei-Phasen-Ansatz verhindert ein Aussperren, falls die Antwort verloren geht.

Endpunkt-Übersicht

System

Methode Endpunkt Auth Beschreibung
GET /api/v1/system/alive Healthcheck
GET /api/v1/system/info READ Systeminformationen
GET /api/v1/system/led READ LED-Status
GET /api/v1/system/wifi_scan WLAN-Scan
GET /api/v1/system/timezones READ Zeitzonen-Liste
POST /api/v1/system/reboot WRITE Neustart

History

Methode Endpunkt Auth Beschreibung
GET /api/v1/history/latest READ Aktuellster Messwert
GET /api/v1/history/highRes?date=YYYY-MM-DD READ 15-Min-Daten für einen Tag
GET /api/v1/history/lowRes?start=YYYY-MM-DD&days=7 READ Tageswerte

Einstellungen

Methode Endpunkt Auth Beschreibung
GET /api/v1/settings READ Einstellungen lesen
POST /api/v1/settings WRITE Einstellungen ändern (partiell)
POST /api/v1/auth/tokens/generate WRITE Neue Tokens generieren
POST /api/v1/auth/tokens/confirm WRITE Tokens aktivieren
GET /api/v1/mqtt/ca READ CA-Zertifikat-Status
POST /api/v1/mqtt/ca WRITE CA-Zertifikat hochladen
DELETE /api/v1/mqtt/ca WRITE CA-Zertifikat löschen
POST /api/v1/cloud/pair WRITE Cloud-Pairing-Token senden
DELETE /api/v1/cloud/pair WRITE Cloud-Pairing aufheben

OTA

Methode Endpunkt Auth Beschreibung
GET /api/v1/ota/check READ Update prüfen
POST /api/v1/ota/start WRITE Update starten

Logs / Debug

Methode Endpunkt Auth Beschreibung
GET /api/v1/logs/rawdump READ SmartMeter Ringbuffer (binär)
GET /api/v1/logs/persistent READ Persistentes CSV-Logfile
GET /api/v1/logs/ram READ RAM-Log Snapshot (CSV)
GET /api/v1/debug/listFS READ SPIFFS Dateiliste

Interaktive API-Dokumentation

Die vollständige API-Spezifikation im OpenAPI-Format:

Hinweis

Die API-Dokumentation wird automatisch aus der Firmware-OpenAPI-Spezifikation generiert.