PlainApp
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 · பிழைகள்

முதல் frame: 10 வினாடி. சரியான முதல் frame பின் handshake-க்கு 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
}