API 參考
認證與權杖
裝置登入與 token。登入後,token 與 c-id 必須屬於同一工作階段。
裝置登入流程
伺服器設定
用戶端
https://<host>:<port>/init伺服器
POST /init
HTTP request
c-id: clientId · body: empty
將游標移至欄位或點按
sessionKey = Base64Decode(token)。登入時雙方各自衍生,不作為 Bearer 傳送。logout 或 revokeSession 撤銷登入工作階段;修改密碼不會自動撤銷。
在裝置 App 的連線 → API 權杖中建立,成對複製 clientId 和 token。刪除該權杖即可撤銷。Bearer 僅透過 HTTPS 傳送。
HTTP 本文加密無法保護下載的網頁程式碼。首次使用需要可信的伺服器身分;瀏覽器應使用可信 HTTPS。
尚未驗證的連線過多時,伺服器會在升級至 WebSocket 前回傳 HTTP 429,且回應內容為空。請稍後再試。
WebSocket /auth · AuthErrorCode · 錯誤
首幀 10 秒;有效首幀後 60 秒內完成交握;登入及等待核准共 300 秒。
INVALID_LOGIN_REQUEST- 檢查登入請求格式,再重新發起交握。
PASSWORD_SETUP_REQUIRED- 請先在裝置上設定登入密碼。
INVALID_PASSWORD- 檢查密碼後重試。
PEER_IDENTITY_CHANGED- 確認裝置身分後再繼續。
REMOTE_ACCESS_DISABLED- 在裝置上開啟遠端存取。
REJECTED- 裝置擁有者拒絕了登入。
TIMEOUT- 重新發起登入請求。
TOO_MANY_LOGIN_ATTEMPTS- 稍後再試。
操作
http
Bearer API Token
使用獨立 API Token,透過 HTTPS 傳送 JSON,不做請求本文加密。
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
撤銷呼叫用戶端目前的已認證工作階段。
graphql
mutation logout {
logout
}