مرجع Lingara API
نسخهٔ API 2026-10-affable-towhee
به زبان‌هایی که Lingara تدریس می‌کند، لست‌های لغات و پلان‌های درسی بسازید و با معلم خصوصی گفتگو کنید. هزینهٔ هر فراخوانی را کلاینتی می‌پردازد که آن را انجام می‌دهد: کلاینت allowance از سهمیهٔ مالک خود مصرف می‌کند و برای کلاینت metered بابت استفاده‌اش بل صادر می‌شود.
کتابخانه را ترجیح می‌دهید؟ بخش کتابخانه‌ها را ببینید.
آدرس اساسی https://api.getlingara.com
یک توکن دسترسی OAuth 2.0 که به شکل Authorization: Bearer <token> فرستاده می‌شود. سروری که از جانب خودش کار می‌کند شناسه و رمز کلاینت خود را در نشانی توکن مبادله می‌کند (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
اگر ترجمه با مرجع انگلیسی فرق داشته باشد، مرجع انگلیسی درست است.