PlainApp
Referência da API

Autenticação & Tokens

Início de sessão no dispositivo e token. Após iniciar sessão, token e c-id devem pertencer à mesma sessão.

Fluxo de início de sessão no dispositivo

Cliente
https://<host>:<port>/init
Servidor

POST /init

HTTP request

c-id: clientId · body: empty

Passar o cursor ou tocar num campo
1 / 7

sessionKey = Base64Decode(token). Derivada nos dois lados no login; não enviar como Bearer. logout ou revokeSession revoga a sessão; mudar a palavra-passe não.

Criar em Ligações → Tokens API na aplicação do dispositivo. Copiar clientId e token juntos. Eliminar revoga o token. Enviar Bearer apenas por HTTPS.

A encriptação HTTP não protege o código web descarregado. O primeiro uso exige uma identidade de servidor fiável; usar HTTPS fiável no navegador.

Se houver demasiadas ligações não autenticadas abertas, o servidor devolve HTTP 429 com um corpo vazio antes de mudar para WebSocket. Tente novamente mais tarde.

WebSocket /auth · AuthErrorCode · Erros

Primeiro frame: 10 s. Depois, 60 s para terminar o handshake. Login e aprovação: 300 s no total.

INVALID_LOGIN_REQUEST
Verifique o pedido de início de sessão e inicie uma nova negociação.
PASSWORD_SETUP_REQUIRED
Defina primeiro uma palavra-passe de início de sessão no dispositivo.
INVALID_PASSWORD
Confira a senha e tente novamente.
PEER_IDENTITY_CHANGED
Verifique a identidade do dispositivo antes de continuar.
REMOTE_ACCESS_DISABLED
Ative o acesso remoto no dispositivo.
REJECTED
O proprietário rejeitou o acesso.
TIMEOUT
Inicie um novo pedido de acesso.
TOO_MANY_LOGIN_ATTEMPTS
Aguarde antes de tentar novamente.

Operações

http

Token de API Bearer

Usar um token de API separado para enviar JSON por HTTPS sem cifrar o corpo.

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

Revogar a sessão autenticada atual do cliente que efetua a chamada.

graphql
mutation logout {
  logout
}