Zum Inhalt

Referenz auf Englisch

Methoden-, Feld- und Typnamen sowie die Beschreibungen unten sind die der API selbst, auf Englisch. Sie bleiben unverändert: es sind genau die Zeichenketten, die Sie in Ihren Anfragen schreiben. Übersetzt sind nur die erläuternden Seiten.

JSON-RPC-API-Referenz

Jede Methode, Benachrichtigung und jeder Typ der JSON-RPC-API der Box, erzeugt aus der Introspektion von nymea (JSONRPC.Introspect). Für Verbindung und Authentifizierung lesen Sie zuerst den Leitfaden.

Berechtigungs-Badges

Jede Methode trägt das Recht, das das Konto für ihren Aufruf haben muss.

Badge Scope Beschreibung
AUTH PermissionScopeNone Jedes angemeldete Konto (Token nötig, sobald der Transport Authentifizierung verlangt; nur JSONRPC.Hello, Authenticate und RequestPushButtonAuth gehen ohne)
CONTROL PermissionScopeControlThings / ExecuteRules Steuerung von Geräten und Regeln
CONFIGURE PermissionScopeConfigureThings / ConfigureRules Konfiguration von Integrationen und Regeln
ADMIN PermissionScopeAdmin Systemadministration