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 ব্যবহার করুন।

ওয়েবসকেট আপগ্রেডের আগে একসঙ্গে অনেকগুলি প্রমাণীকরণবিহীন সংযোগ থাকলে সার্ভার খালি বডিসহ HTTP 429 ফেরত দেয়। পরে আবার চেষ্টা করুন।

WebSocket /auth · AuthErrorCode · ত্রুটি

প্রথম ফ্রেম: ১০ সেকেন্ড। বৈধ প্রথম ফ্রেমের পর হ্যান্ডশেকের জন্য ৬০ সেকেন্ড। লগইন ও অনুমোদন মোট ৩০০ সেকেন্ড।

INVALID_LOGIN_REQUEST
লগইন অনুরোধ পরীক্ষা করে নতুন হ্যান্ডশেক শুরু করুন।
PASSWORD_SETUP_REQUIRED
প্রথমে ডিভাইসে লগইন পাসওয়ার্ড সেট করুন।
INVALID_PASSWORD
পাসওয়ার্ড যাচাই করে আবার চেষ্টা করুন।
PEER_IDENTITY_CHANGED
এগোনোর আগে ডিভাইসের পরিচয় যাচাই করুন।
REMOTE_ACCESS_DISABLED
ডিভাইসে দূরবর্তী প্রবেশ চালু করুন।
REJECTED
ডিভাইসের মালিক লগইন প্রত্যাখ্যান করেছেন।
TIMEOUT
নতুন লগইন অনুরোধ শুরু করুন।
TOO_MANY_LOGIN_ATTEMPTS
আবার চেষ্টা করার আগে অপেক্ষা করুন।

অপারেশন

http

Bearer API টোকেন

বডি এনক্রিপশন ছাড়া HTTPS-এ JSON পাঠাতে আলাদা API Token ব্যবহার করুন।

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
}