مرجع Lingara API
نسخهٔ API 2026-10-affable-towhee
فهرست واژگان و طرح درس بسازید و با مربی گفتگو کنید، به زبان‌هایی که Lingara آموزش می‌دهد. هزینهٔ هر فراخوانی را کلاینتی می‌پردازد که آن را انجام می‌دهد: کلاینت allowance از سهمیهٔ مالکش مصرف می‌کند و کلاینت metered بابت مصرفش صورت‌حساب می‌گیرد.
کتابخانه را ترجیح می‌دهید؟ بخش کتابخانه‌ها را ببینید.
نشانی پایه https://api.getlingara.com
یک توکن دسترسی OAuth 2.0 که به‌صورت Authorization: Bearer <token> ارسال می‌شود. سروری که از طرف خودش عمل می‌کند شناسه و رمز کلاینت خود را در نشانی URL توکن مبادله می‌کند (client_credentials). برنامه‌ای که از طرف کاربری از Lingara که رضایت می‌دهد عمل می‌کند، از کد مجوز (authorization_code) استفاده می‌کند و سپس توکن را تازه می‌کند. هر توکن یک ساعت اعتبار دارد. هر عملیات به یک دامنهٔ دسترسی نیاز دارد.
نشانی توکن https://api.getlingara.com/oauth/token
vocab:generate | ساخت فهرست واژگان. | ساخت فهرست واژگان |
lesson_plans:read | خواندن طرح‌های درس خود و اتصال دوباره به پیشرفت آن‌ها. | دریافت طرح درساتصال دوباره به طرح درس |
lesson_plans:write | ساخت طرح درس. | ساخت طرح درس |
tutor:converse | گفتگو با مربی. به اشتراک پولی نیاز دارد. | ارسال یک نوبت به مربی |
usage:read | مشاهدهٔ سهمیهٔ باقی‌مانده، یا مصرف این ماه یک کلاینت `metered`. | دریافت سهمیهٔ باقی‌مانده |
events:read | خواندن رویدادهای مربوط به حساب شما، و ثبت نقطه‌های پایانی که آن‌ها را دریافت می‌کنند. | فهرست رویدادهاجریان رویدادها |
events:write | فرستادن رویدادها از بازی یا یکپارچه‌سازی شما به Lingara. | ارسال رویداد |
خطاها
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الزامی
واژگان
ساخت فهرست واژگان متناسب با سطح زبان‌آموز.
- ساخت فهرست واژگان
POST /v1/vocab/stream
طرح‌های درس
ساخت طرح درس، خواندن آن‌ها و اتصال دوباره به طرحی که هنوز در حال ساخت است.
- ساخت طرح درس
POST /v1/lesson-plans - دریافت طرح درس
GET /v1/lesson-plans/{id} - اتصال دوباره به طرح درس
GET /v1/lesson-plans/{id}/stream
مربی
گفتگو با مربی زبان، نوبت به نوبت.
- ارسال یک نوبت به مربی
POST /v1/tutor/message
رویدادها
رویدادهایی را که در حساب شما رخ می‌دهند بخوانید، صفحه به صفحه یا به‌صورت جریان.
- فهرست رویدادها
GET /v1/events - ارسال رویداد
POST /v1/events - جریان رویدادها
GET /v1/events/stream
حساب
ببینید چه مقدار از سهمیهٔ شما باقی مانده است.
- دریافت سهمیهٔ باقی‌مانده
GET /v1/usage
مرجع
همین سند، در قالبی ماشین‌خوان.
- دریافت این سند
GET /v1/openapi.json - دریافت سند رویدادها
GET /v1/asyncapi.json - فهرست نسخه‌های API
GET /v1/versions - دریافت یک نسخهٔ API
GET /v1/versions/{id}
فهرست رویدادها
Lingara آنچه را برای طرح‌های درس و میزان استفادهٔ حساب شما رخ می‌دهد به‌صورت رویداد ثبت می‌کند و رویدادها را از بازی یا برنامهٔ شما می‌پذیرد. هر رویداد، از هر راهی که برود، پاکت یکسانی دارد و فهرست رویدادها همهٔ آن‌ها را برمی‌شمارد. وب‌هوک‌ها و رویدادها
- Lingara ← شما
lesson_plan.ready - Lingara ← شما
lesson_plan.failed - Lingara ← شما
usage.threshold_reached - Lingara ← شما
webhook.test - Lingara ← شما
app.installed - Lingara ← شما
app.uninstalled
- شما ← Lingara
world.context_changed - شما ← Lingara
world.practice_requested
اگر ترجمه با مرجع انگلیسی تفاوت داشته باشد، مرجع انگلیسی معتبر است.