Lingara API-verwysing

Foute

402application/json

'n Oproep van 'n gemeterde kliënt is geweier voordat dit iets bestee het. spend_cap_reached: die kliënt of sy rekening het sy maandelikse bestedingslimiet bereik; verhoog die limiet op die Integrasies-bladsy. metered_billing_inactive: gebruiksfakturering is nie aktief vir hierdie rekening nie; stel dit op, of werk die betaalmetode by, op die Integrasies-bladsy.

410application/json

Die API-weergawe waaronder hierdie versoek beantwoord word, is gestaak. Stuur 'n ondersteunde weergawe in Lingara-Version, of koppel die kliënt aan 'n ander weergawe.

4XXapplication/json

Die versoek is geweier. code sê hoekom, en error sê dit in woorde.

503application/json · text/plain

Die diens is tydelik onbeskikbaar; probeer weer na die aantal sekondes in Retry-After. Tydens onderhoud is die liggaam gewone teks eerder as die foutomhulsel.

5XXapplication/json

Die versoek is geweier. code sê hoekom, en error sê dit in woorde.

codestringverplig

Waarom die versoek geweier is, as 'n stabiele kode om op te vertak: byvoorbeeld insufficient_scope (403), rate_limited (429) en, vir 'n gemeterde kliënt, spend_cap_reached (402) en metered_billing_inactive (402).

errorstringverplig

Woordeskat

Genereer woordelyste op 'n leerder se vlak.

• Genereer 'n woordelys POST /v1/vocab/stream

Lesplanne

Skep lesplanne, lees hulle, en herkoppel aan een wat nog gegenereer word.

• Skep 'n lesplan POST /v1/lesson-plans
• Kry 'n lesplan GET /v1/lesson-plans/{id}
• Herkoppel aan 'n lesplan GET /v1/lesson-plans/{id}/stream

Tutor

Voer 'n gesprek met die taaltutor, een beurt op 'n slag.

• Stuur 'n tutorbeurt POST /v1/tutor/message

Gebeurtenisse

Lees die gebeurtenisse in jou rekening, bladsy vir bladsy of as 'n stroom.

• Lys gebeurtenisse GET /v1/events
• Stuur 'n gebeurtenis POST /v1/events
• Stroom gebeurtenisse GET /v1/events/stream

Rekening

Sien hoeveel van jou toelae oor is.

• Kry jou oorblywende toelae GET /v1/usage

Verwysing

Hierdie dokument, in masjienleesbare vorm.

• Kry hierdie dokument GET /v1/openapi.json
• Kry die gebeurtenisdokument GET /v1/asyncapi.json
• Lys API-weergawes GET /v1/versions
• Kry 'n API-weergawe GET /v1/versions/{id}

Gebeurteniskatalogus

Lingara teken aan wat met jou rekening se lesplanne en gebruik gebeur as gebeurtenisse, en aanvaar gebeurtenisse van jou speletjie of toep. Elke gebeurtenis, watter pad dit ook al volg, het dieselfde koevert, en die gebeurteniskatalogus lys hulle almal. Webhake en gebeurtenisse

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

• Jy → Lingara world.context_changed
• Jy → Lingara world.practice_requested