پیوند دادن بازیکن به حساب Lingara او

نسخهٔ API 2026-10-virile-dragon

put https://api.getlingara.com/v1/embed/players/{player_ref}/link

یکی از بازیکنان شما را به حساب Lingara که همین حالا به برنامه شما دسترسی داده پیوند می‌دهد. آن را با توکن واگذارشده‌ای که سرور شما برای آن حساب دریافت کرده فراخوانی کنید، هرگز با توکن خود کلاینتتان. از آن پس توکن‌های بازیکن به‌جای حساب عمل می‌کنند، تا جایی که مجوز اجازه می‌دهد: events:read را درخواست کنید وگرنه پس از پیوند چیزی درباره بازیکن نمی‌شنوید. طرح‌های تکمیل‌شده به حساب منتقل می‌شوند؛ طرحی که هنوز در حال نوشتن است تا فراخوانی دوباره شما می‌ماند. تکرار آن بی‌خطر است: تکرار پاسخ existing می‌دهد و آنچه را قبلاً منتقل نمی‌شد منتقل می‌کند. پیوند دادن برای شما هزینه‌ای ندارد.

دامنه‌های دسترسی embed:play

پارامترها

Lingara-Versionheaderstringاختیاری: نسخهٔ API‌ای که این درخواست با آن پاسخ داده می‌شود. بدون آن، توکن دسترسی نسخه‌ای را می‌گیرد که کلاینتش به آن متصل است، و درخواستی بدون توکن نسخهٔ فعلی را می‌گیرد. به نسخه‌ای که هنوز در حال توسعه است فقط با نام‌بردن آن در اینجا می‌توان رسید. نسخهٔ ناشناخته با 400 و کد api_version_unknown پاسخ داده می‌شود. GET /v1/versions نسخه‌ها را فهرست می‌کند.
player_refpathstringالزامی: player_ref که با آن توکن‌های بازیکن را صادر کرده‌اید، با کدگذاری درصدی: guild/42 می‌شود guild%2F42.

پاسخ‌ها

200 پیوند بازیکن

statusLinkStatusالزامی
subjectstringالزامی: lgr_sub_ حساب: آنچه رویدادهای این بازیکن از این پس با خود دارند.
previous_subjectstringالزامی: lgr_sub_ مهمان: آنچه رویدادهای قبلی بازیکن نگه می‌دارند. هر دو را به همان player_ref هدایت کنید.
linked_atstringالزامی: زمان ایجاد پیوند. در پاسخ existing، زمان نخستین فراخوانی.
scopesarray of stringالزامی: بیشترین چیزی که توکنی برای این بازیکن اکنون می‌تواند داشته باشد: آنچه حساب مجوز داده، از میان دامنه‌هایی که توکن بازیکن می‌تواند داشته باشد.
carriedobjectالزامی: ردیف‌هایی که این فراخوانی به حساب منتقل کرد، به تفکیک جدول. فقط جدول‌هایی که شمارشی دارند نمایش داده می‌شوند.
keptobjectالزامی: ردیف‌هایی که این فراخوانی نزد مهمان گذاشت، به تفکیک جدول: طرحی که هنوز در حال نوشتن است، یا ردیفی که حساب از قبل داشت. وقتی lesson_plans در اینجا طرح تمام‌شده‌ای داشت، دوباره فراخوانی کنید.

خطاها

402application/json: فراخوانی یک کلاینت مصرفی پیش از آنکه چیزی خرج کند رد شد. spend_cap_reached: کلاینت یا حساب آن به سقف هزینهٔ ماهانهٔ خود رسیده است؛ سقف را در صفحهٔ یکپارچه‌سازی‌ها بالا ببرید. metered_billing_inactive: صورت‌حساب مصرفی برای این حساب فعال نیست؛ آن را در صفحهٔ یکپارچه‌سازی‌ها راه‌اندازی کنید یا روش پرداخت را به‌روز کنید.
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 PUT "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

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

اگر ترجمه با مرجع انگلیسی تفاوت داشته باشد، مرجع انگلیسی معتبر است.