دەرکردنی تۆکێن بۆ یاریزانێک

پارامەترەکان

Lingara-Versionheaderstringئارەزوومەندانە

ئەو وەشانەی API کە ئەم داواکارییەی پێ وەڵام دەدرێتەوە. بەبێ ئەمە، تۆکنی دەستگەیشتن ئەو وەشانە وەردەگرێت کە کڕیارەکەی پێیەوە بەستراوە، و داواکارییەکی بێ تۆکن وەشانی ئێستا وەردەگرێت. وەشانێک کە هێشتا لە گەشەپێداندایە تەنها بە ناوهێنانی لێرە دەگەیەندرێت. وەشانێکی نەناسراو بە 400 لەگەڵ کۆدی api_version_unknown وەڵام دەدرێتەوە. GET /v1/versions وەشانەکان لیست دەکات.

ناوەڕۆکی داواکاری application/json

player_refstringپێویست

ئاماژەی تایبەتی خۆت بۆ یاریزانەکە: ١ تا ١٢٨ بایت UTF-8، بێ پیتی کۆنترۆڵ. Lingara تەنها هاشەکەی هەڵدەگرێت.

scopesarray of string | nullئارەزوومەندانە

originstring | nullئارەزوومەندانە

وەڵامەکان

200 تۆکێنی یاریزانەکە

tokenstringپێویست

expires_atstringپێویست

expires_inintegerپێویست

چرکەکان تا بەسەرچوونی تۆکێنەکە، لەم وەڵامەوە دەژمێردرێن. کاتێک ناتوانرێت متمانە بە کاتژمێری ئامێرەکە بکرێت بەکاری بهێنە.

subjectstringپێویست

scopesarray of stringپێویست

account_linkedbooleanپێویست

هەڵەکان

410application/json

ئەو وەشانەی API کە ئەم داواکارییەی پێ وەڵام دەدرێتەوە ڕاگیراوە. وەشانێکی پشتگیریکراو لە Lingara-Version بنێرە، یان کڕیارەکە بە وەشانێکی ترەوە ببەستەوە.

4XXapplication/json

داواکارییەکە ڕەتکرایەوە. code هۆکارەکەی دەڵێت، و error بە وشە ڕوونی دەکاتەوە.

503application/json · text/plain

خزمەتگوزارییەکە بە شێوەیەکی کاتی بەردەست نییە؛ دوای ئەو ژمارە چرکەیەی کە Retry-After دیاری دەکات دووبارە هەوڵ بدەرەوە. لە کاتی چاککردنەوەدا، ناوەڕۆکی وەڵامەکە دەقی سادەیە نەک پێچراوەی هەڵە.

5XXapplication/json

داواکارییەکە ڕەتکرایەوە. code هۆکارەکەی دەڵێت، و error بە وشە ڕوونی دەکاتەوە.

codestringپێویست

هۆکاری ڕەتکردنەوەی داواکارییەکە، وەک کۆدێکی جێگیر بۆ لقبوونەوە لەسەری: بۆ نموونە insufficient_scope (403)، rate_limited (429) و، بۆ کلاینتێکی پێوانەکراو، spend_cap_reached (402) و metered_billing_inactive (402).

errorstringپێویست

نموونە

curl -X POST "https://api.getlingara.com/v1/embed/tokens" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"player_ref":"player-1001","scopes":["embed:play","lesson_plans:read","lesson_plans:write"],"origin":"https://game.example.com"}'

کتێبخانەیەکت پێ باشترە؟ بەشی کتێبخانەکان ببینە.