API संदर्भ

Auth और टोकन

डिवाइस लॉगिन और टोकन। लॉगिन के बाद token और c-id एक ही सत्र के होने चाहिए।

डिवाइस लॉगिन प्रक्रिया

क्लाइंट
https://<host>:<port>/init
सर्वर

POST /init

HTTP request

c-id: clientId · body: empty

फ़ील्ड पर होवर या टैप करें
1 / 7

sessionKey = Base64Decode(token)। लॉगिन में दोनों पक्ष इसे बनाते हैं; Bearer के रूप में न भेजें। logout या revokeSession सत्र रद्द करता है; पासवर्ड बदलना नहीं।

डिवाइस ऐप में कनेक्शन → 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 टोकन

अलग 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
}