PlainApp
API-referentie

Authenticatie & Tokens

Inloggen op het apparaat en token. Na inloggen moeten token en c-id bij dezelfde sessie horen.

Inlogproces voor apparaten

Client
https://<host>:<port>/init
Server

POST /init

HTTP request

c-id: clientId · body: empty

Beweeg over een veld of tik erop
1 / 7

sessionKey = Base64Decode(token). Beide kanten leiden deze af bij aanmelden; niet als Bearer verzenden. logout of revokeSession trekt de sessie in; een wachtwoordwijziging niet.

Maak aan via Verbindingen → API-tokens in de apparaat-app. Kopieer clientId en token samen. Verwijderen trekt het token in. Verstuur Bearer alleen via HTTPS.

HTTP-bodyversleuteling beschermt gedownloade webcode niet. Eerste gebruik vereist een vertrouwde serveridentiteit; gebruik vertrouwd HTTPS in de browser.

Als er te veel niet-geverifieerde verbindingen openstaan, stuurt de server vóór de WebSocket-upgrade HTTP 429 met een lege body terug. Probeer het later opnieuw.

WebSocket /auth · AuthErrorCode · Fouten

Eerste frame: 10 s. Daarna 60 s voor de handshake. Aanmelding en goedkeuring samen: 300 s.

INVALID_LOGIN_REQUEST
Controleer de aanmeldaanvraag en start een nieuwe handshake.
PASSWORD_SETUP_REQUIRED
Stel eerst een aanmeldwachtwoord in op het apparaat.
INVALID_PASSWORD
Controleer het wachtwoord en probeer opnieuw.
PEER_IDENTITY_CHANGED
Controleer de apparaatidentiteit voordat je doorgaat.
REMOTE_ACCESS_DISABLED
Schakel externe toegang op het apparaat in.
REJECTED
De eigenaar heeft de aanmelding geweigerd.
TIMEOUT
Start een nieuwe aanmelding.
TOO_MANY_LOGIN_ATTEMPTS
Wacht voordat je opnieuw probeert.

Bewerkingen

http

Bearer-API-token

Gebruik een afzonderlijk API-token om JSON via HTTPS zonder bodyversleuteling te versturen.

bash
curl --request POST \
  --url 'https://<device-host>:<https-port>/graphql' \
  --header 'c-id: <client-id>' \
  --header 'Authorization: Bearer <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{"query":"{ app { deviceName capabilities access } }"}'
mutation

logout

De huidige geauthenticeerde sessie van de aanroepende client intrekken.

graphql
mutation logout {
  logout
}