صدور توکن برای بازیکن

پارامترها

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"}'

کتابخانه را ترجیح می‌دهید؟ بخش کتابخانه‌ها را ببینید.