إصدار رمز لاعب

المعاملات

Lingara-Versionheaderstringاختياري

إصدار API الذي يُجاب عن هذا الطلب به. بدونه، يحصل رمز الوصول على الإصدار الذي رُبط به عميله، ويحصل الطلب الذي لا رمز مميز فيه على الإصدار الحالي. لا يمكن الوصول إلى الإصدار الذي لا يزال قيد التطوير إلا بذكره هنا. الإصدار غير المعروف يُجاب عنه بـ 400 مع الرمز api_version_unknown. يسرد GET /v1/versions الإصدارات.

متن الطلب application/json

player_refstringمطلوب

مرجعك الخاص للاعب: من 1 إلى 128 بايت من 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"}'

تفضّل مكتبة؟ راجع قسم المكتبات.