Lingara API referansı

Hatalar

402application/json

Kullanım başına ücretlendirilen bir istemcinin çağrısı, hiçbir şey harcamadan reddedildi. spend_cap_reached: istemci veya hesabı aylık harcama sınırına ulaştı; sınırı Entegrasyonlar sayfasında yükseltin. metered_billing_inactive: bu hesap için kullanım başına ücretlendirme etkin değil; Entegrasyonlar sayfasında kurun veya ödeme yöntemini güncelleyin.

410application/json

Bu isteğin yanıtlandığı API sürümü sonlandırıldı. Lingara-Version içinde desteklenen bir sürüm gönderin veya istemciyi başka bir sürüme bağlayın.

4XXapplication/json

İstek reddedildi. code nedenini belirtir, error ise bunu sözcüklerle açıklar.

503application/json · text/plain

Hizmet geçici olarak kullanılamıyor; Retry-After içindeki saniye sayısı kadar bekledikten sonra yeniden deneyin. Bakım sırasında gövde, hata zarfı yerine düz metindir.

5XXapplication/json

İstek reddedildi. code nedenini belirtir, error ise bunu sözcüklerle açıklar.

codestringzorunlu

İsteğin neden reddedildiği, dallanmak için kullanılabilecek sabit bir kod olarak: örneğin insufficient_scope (403), rate_limited (429) ve kullanım başına ücretlendirilen bir istemci için spend_cap_reached (402) ile metered_billing_inactive (402).

errorstringzorunlu

Kelimeler

Bir öğrencinin seviyesine uygun kelime listeleri oluşturun.

• Kelime listesi oluştur POST /v1/vocab/stream

Ders planları

Ders planları oluşturun, okuyun ve hâlâ oluşturulmakta olan bir plana yeniden bağlanın.

• Ders planı oluştur POST /v1/lesson-plans
• Ders planını getir GET /v1/lesson-plans/{id}
• Ders planına yeniden bağlan GET /v1/lesson-plans/{id}/stream

Eğitmen

Dil eğitmeniyle her seferinde bir tur olmak üzere sohbet edin.

• Eğitmene bir tur gönder POST /v1/tutor/message

Olaylar

Hesabınızda olan olayları sayfa sayfa ya da akış olarak okuyun.

• Olayları listele GET /v1/events
• Olay gönder POST /v1/events
• Olayları akışla al GET /v1/events/stream

Hesap

Kullanım hakkınızdan ne kadar kaldığını görün.

• Kalan kullanım hakkınızı getirin GET /v1/usage

Referans

Bu belge, makine tarafından okunabilir biçimde.

• Bu belgeyi getir GET /v1/openapi.json
• Olaylar belgesini getir GET /v1/asyncapi.json
• API sürümlerini listele GET /v1/versions
• Bir API sürümünü getir GET /v1/versions/{id}

Olay kataloğu

Lingara, hesabınızın ders planlarına ve kullanımına olanları olay olarak kaydeder ve oyununuzdan veya uygulamanızdan olay kabul eder. Hangi yoldan iletilirse iletilsin her olayın zarfı aynıdır ve olay kataloğu hepsini listeler. Webhook'lar ve olaylar

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

• Siz → Lingara world.context_changed
• Siz → Lingara world.practice_requested