Referensi API Lingara

Galat

402application/json

Panggilan klien dengan penagihan per pemakaian ditolak sebelum menghabiskan apa pun. spend_cap_reached: klien atau akunnya telah mencapai batas pengeluaran bulanannya; naikkan batasnya di halaman Integrasi. metered_billing_inactive: penagihan per pemakaian tidak aktif untuk akun ini; siapkan, atau perbarui metode pembayarannya, di halaman Integrasi.

410application/json

Versi API yang digunakan untuk menjawab permintaan ini telah dihentikan. Kirim versi yang didukung di Lingara-Version, atau sematkan klien ke versi lain.

4XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

503application/json · text/plain

Layanan sementara tidak tersedia; coba lagi setelah jumlah detik di Retry-After. Selama pemeliharaan, isi respons berupa teks biasa, bukan amplop galat.

5XXapplication/json

Permintaan ditolak. code menyebutkan alasannya, dan error menjelaskannya dengan kata-kata.

codestringwajib

Alasan permintaan ditolak, sebagai kode tetap untuk percabangan: misalnya insufficient_scope (403), rate_limited (429) dan, untuk klien dengan penagihan per pemakaian, spend_cap_reached (402) dan metered_billing_inactive (402).

errorstringwajib

Kosakata

Buat daftar kosakata sesuai tingkat pelajar.

• Buat daftar kosakata POST /v1/vocab/stream

Rencana pelajaran

Buat rencana pelajaran, baca, dan sambungkan kembali ke rencana yang masih dibuat.

• Buat rencana pelajaran POST /v1/lesson-plans
• Ambil rencana pelajaran GET /v1/lesson-plans/{id}
• Sambungkan kembali ke rencana pelajaran GET /v1/lesson-plans/{id}/stream

Tutor

Bercakap dengan tutor bahasa, satu giliran setiap kali.

• Kirim giliran tutor POST /v1/tutor/message

Peristiwa

Baca peristiwa yang terjadi di akun Anda, halaman demi halaman atau sebagai stream.

• Daftar peristiwa GET /v1/events
• Kirim peristiwa POST /v1/events
• Stream peristiwa GET /v1/events/stream

Akun

Lihat sisa kuota Anda.

• Lihat sisa kuota Anda GET /v1/usage

Referensi

Dokumen ini, dalam bentuk yang dapat dibaca mesin.

• Ambil dokumen ini GET /v1/openapi.json
• Ambil dokumen event GET /v1/asyncapi.json
• Daftar versi API GET /v1/versions
• Dapatkan satu versi API GET /v1/versions/{id}

Katalog peristiwa

Lingara mencatat apa yang terjadi pada rencana pelajaran dan penggunaan akun Anda sebagai peristiwa, dan menerima peristiwa dari game atau aplikasi Anda. Setiap peristiwa, lewat jalur mana pun, memiliki amplop yang sama, dan katalog peristiwa mencantumkan 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