Rujukan API Lingara

Ralat

402application/json

Panggilan klien bermeter telah ditolak sebelum ia membelanjakan apa-apa. spend_cap_reached: klien atau akaunnya telah mencapai had perbelanjaan bulanannya; naikkan had di halaman Integrasi. metered_billing_inactive: pengebilan bermeter tidak aktif untuk akaun ini; sediakannya, atau kemas kini kaedah pembayaran, di halaman Integrasi.

410application/json

Versi API yang digunakan untuk menjawab permintaan ini telah dihentikan. Hantar versi yang disokong dalam Lingara-Version, atau pautkan klien kepada versi lain.

4XXapplication/json

Permintaan ditolak. code menyatakan sebabnya, dan error menerangkannya dengan perkataan.

503application/json · text/plain

Perkhidmatan tidak tersedia buat sementara waktu; cuba lagi selepas bilangan saat dalam Retry-After. Semasa penyelenggaraan, kandungan ialah teks biasa dan bukan sampul ralat.

5XXapplication/json

Permintaan ditolak. code menyatakan sebabnya, dan error menerangkannya dengan perkataan.

codestringwajib

Sebab permintaan ditolak, sebagai kod stabil untuk dijadikan asas percabangan: contohnya insufficient_scope (403), rate_limited (429) dan, bagi klien bermeter, spend_cap_reached (402) dan metered_billing_inactive (402).

errorstringwajib

Kosa kata

Jana senarai kosa kata pada tahap pelajar.

• Jana senarai kosa kata POST /v1/vocab/stream

Rancangan pelajaran

Cipta rancangan pelajaran, bacanya, dan sambung semula kepada rancangan yang masih dijana.

• Cipta rancangan pelajaran POST /v1/lesson-plans
• Dapatkan rancangan pelajaran GET /v1/lesson-plans/{id}
• Sambung semula kepada rancangan pelajaran GET /v1/lesson-plans/{id}/stream

Tutor

Bercakap dengan tutor bahasa, satu giliran pada satu masa.

• Hantar giliran tutor POST /v1/tutor/message

Peristiwa

Baca peristiwa yang berlaku dalam akaun anda, halaman demi halaman atau sebagai strim.

• Senaraikan peristiwa GET /v1/events
• Hantar peristiwa POST /v1/events
• Strim peristiwa GET /v1/events/stream

Akaun

Lihat baki kuota anda.

• Dapatkan baki kuota anda GET /v1/usage

Rujukan

Dokumen ini, dalam bentuk yang boleh dibaca mesin.

• Dapatkan dokumen ini GET /v1/openapi.json
• Dapatkan dokumen acara GET /v1/asyncapi.json
• Senaraikan versi API GET /v1/versions
• Dapatkan satu versi API GET /v1/versions/{id}

Katalog peristiwa

Lingara merekodkan perkara yang berlaku pada rancangan pelajaran dan penggunaan akaun anda sebagai peristiwa, dan menerima peristiwa daripada permainan atau aplikasi anda. Setiap peristiwa, melalui mana-mana laluan, mempunyai sampul yang sama, dan katalog peristiwa menyenaraikan semuanya. Webhook dan peristiwa

• Lingara → anda lesson_plan.ready
• Lingara → anda lesson_plan.failed
• Lingara → anda usage.threshold_reached
• Lingara → anda webhook.test
• Lingara → anda app.installed
• Lingara → anda app.uninstalled

• Anda → Lingara world.context_changed
• Anda → Lingara world.practice_requested