Tài liệu tham chiếu API Lingara

Lỗi

402application/json

Lệnh gọi của một ứng dụng khách tính phí theo mức dùng đã bị từ chối trước khi tiêu bất cứ thứ gì. spend_cap_reached: ứng dụng khách hoặc tài khoản của nó đã chạm hạn mức chi tiêu hằng tháng; hãy nâng hạn mức trên trang Tích hợp. metered_billing_inactive: tính phí theo mức dùng chưa được kích hoạt cho tài khoản này; hãy thiết lập hoặc cập nhật phương thức thanh toán trên trang Tích hợp.

410application/json

Phiên bản API dùng để trả lời yêu cầu này đã bị ngừng. Hãy gửi một phiên bản được hỗ trợ trong Lingara-Version, hoặc gắn ứng dụng khách với một phiên bản khác.

4XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

503application/json · text/plain

Dịch vụ tạm thời không khả dụng; hãy thử lại sau số giây ghi trong Retry-After. Trong thời gian bảo trì, phần thân là văn bản thuần thay vì phong bì lỗi.

5XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

codestringbắt buộc

Lý do yêu cầu bị từ chối, dưới dạng một mã ổn định để rẽ nhánh: ví dụ insufficient_scope (403), rate_limited (429) và, với ứng dụng khách tính phí theo mức dùng, spend_cap_reached (402) và metered_billing_inactive (402).

errorstringbắt buộc

Từ vựng

Tạo danh sách từ vựng phù hợp với trình độ của người học.

• Tạo danh sách từ vựng POST /v1/vocab/stream

Giáo án

Tạo giáo án, đọc giáo án và kết nối lại với giáo án vẫn đang được tạo.

• Tạo giáo án POST /v1/lesson-plans
• Lấy giáo án GET /v1/lesson-plans/{id}
• Kết nối lại với giáo án GET /v1/lesson-plans/{id}/stream

Gia sư

Trò chuyện với gia sư ngôn ngữ, từng lượt một.

• Gửi một lượt cho gia sư POST /v1/tutor/message

Sự kiện

Đọc các sự kiện xảy ra trong tài khoản của bạn, theo từng trang hoặc dưới dạng luồng.

• Liệt kê sự kiện GET /v1/events
• Gửi sự kiện POST /v1/events
• Truyền luồng sự kiện GET /v1/events/stream

Tài khoản

Xem hạn mức của bạn còn lại bao nhiêu.

• Lấy hạn mức còn lại của bạn GET /v1/usage

Tham chiếu

Tài liệu này, ở dạng máy có thể đọc được.

• Lấy tài liệu này GET /v1/openapi.json
• Lấy tài liệu sự kiện GET /v1/asyncapi.json
• Liệt kê các phiên bản API GET /v1/versions
• Lấy một phiên bản API GET /v1/versions/{id}

Danh mục sự kiện

Lingara ghi lại những gì xảy ra với giáo án và mức sử dụng của tài khoản bạn dưới dạng sự kiện, và nhận sự kiện từ trò chơi hoặc ứng dụng của bạn. Mọi sự kiện, dù đi theo đường nào, đều có cùng một phong bì, và danh mục sự kiện liệt kê tất cả. Webhook và sự kiện

• Lingara → bạn lesson_plan.ready
• Lingara → bạn lesson_plan.failed
• Lingara → bạn usage.threshold_reached
• Lingara → bạn webhook.test
• Lingara → bạn app.installed
• Lingara → bạn app.uninstalled

• Bạn → Lingara world.context_changed
• Bạn → Lingara world.practice_requested