Aller au contenu

Référence en anglais

Les noms de méthodes, de champs, de types et les descriptions ci-dessous sont ceux de l'API elle-même, en anglais. Ils sont laissés tels quels : ce sont les chaînes que vous écrirez dans vos requêtes. Seules les pages d'explication sont traduites.

Référence API JSON-RPC

Chaque méthode, notification et type de l'API JSON-RPC de la box, générés depuis l'introspection de nymea (JSONRPC.Introspect). Pour se connecter et s'authentifier, lisez d'abord le guide.

Badges de permission

Chaque méthode porte le droit que le compte doit avoir pour l'appeler.

Badge Scope Description
AUTH PermissionScopeNone Tout compte authentifié (token requis dès que le transport exige l'authentification ; seuls JSONRPC.Hello, Authenticate et RequestPushButtonAuth passent sans)
CONTROL PermissionScopeControlThings / ExecuteRules Contrôle des appareils et règles
CONFIGURE PermissionScopeConfigureThings / ConfigureRules Configuration des intégrations et règles
ADMIN PermissionScopeAdmin Administration système