Lingara API-referentie

Fouten

402application/json

De aanroep van een client met verbruiksafrekening is geweigerd voordat die iets heeft uitgegeven. spend_cap_reached: de client of zijn account heeft zijn maandelijkse uitgavenlimiet bereikt; verhoog de limiet op de pagina Integraties. metered_billing_inactive: verbruiksafrekening is niet actief voor dit account; stel die in of werk de betaalmethode bij op de pagina Integraties.

410application/json

De API-versie waaronder dit verzoek wordt beantwoord, is stopgezet. Stuur een ondersteunde versie mee in Lingara-Version, of koppel de client aan een andere versie.

4XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

503application/json · text/plain

De dienst is tijdelijk niet beschikbaar; probeer het opnieuw na het aantal seconden in Retry-After. Tijdens onderhoud is de body platte tekst in plaats van de foutenvelop.

5XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

codestringverplicht

Waarom het verzoek is geweigerd, als stabiele code om op te vertakken: bijvoorbeeld insufficient_scope (403), rate_limited (429) en, voor een client met verbruiksafrekening, spend_cap_reached (402) en metered_billing_inactive (402).

errorstringverplicht

Woordenschat

Genereer woordenlijsten op het niveau van een leerling.

• Een woordenlijst genereren POST /v1/vocab/stream

Lesplannen

Maak lesplannen, lees ze en maak opnieuw verbinding met een plan dat nog wordt gegenereerd.

• Een lesplan maken POST /v1/lesson-plans
• Een lesplan ophalen GET /v1/lesson-plans/{id}
• Opnieuw verbinden met een lesplan GET /v1/lesson-plans/{id}/stream

Tutor

Voer een gesprek met de taaltutor, beurt voor beurt.

• Een tutorbeurt versturen POST /v1/tutor/message

Gebeurtenissen

Lees de gebeurtenissen in je account, pagina voor pagina of als stream.

• Gebeurtenissen weergeven GET /v1/events
• Een gebeurtenis versturen POST /v1/events
• Gebeurtenissen streamen GET /v1/events/stream

Account

Bekijk hoeveel van je tegoed er nog over is.

• Je resterende tegoed ophalen GET /v1/usage

Referentie

Dit document, in machineleesbare vorm.

• Dit document ophalen GET /v1/openapi.json
• Het eventsdocument ophalen GET /v1/asyncapi.json
• API-versies weergeven GET /v1/versions
• Een API-versie ophalen GET /v1/versions/{id}

Gebeurteniscatalogus

Lingara legt als gebeurtenissen vast wat er met de lesplannen en het gebruik van je account gebeurt, en accepteert gebeurtenissen van je game of app. Elke gebeurtenis heeft, langs welke weg ze ook reist, dezelfde envelop, en de gebeurteniscatalogus somt ze allemaal op. Webhooks en gebeurtenissen

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

• Jij → Lingara world.context_changed
• Jij → Lingara world.practice_requested