Lingara API -viite

Virheet

402application/json

Käytön mukaan laskutettavan asiakkaan kutsu hylättiin ennen kuin se kulutti mitään. spend_cap_reached: asiakas tai sen tili on saavuttanut kuukausittaisen kulutusrajansa; nosta rajaa Integraatiot-sivulla. metered_billing_inactive: käytön mukainen laskutus ei ole tällä tilillä käytössä; ota se käyttöön tai päivitä maksutapa Integraatiot-sivulla.

410application/json

API-versio, jolla tähän pyyntöön vastataan, on lopetettu. Lähetä tuettu versio Lingara-Version-otsakkeessa tai kiinnitä asiakas toiseen versioon.

4XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

503application/json · text/plain

Palvelu ei ole tilapäisesti käytettävissä; yritä uudelleen Retry-After-otsakkeen ilmoittaman sekuntimäärän jälkeen. Huoltokatkon aikana runko on pelkkää tekstiä virhekehyksen sijaan.

5XXapplication/json

Pyyntö hylättiin. code kertoo syyn, ja error kertoo sen sanoin.

codestringpakollinen

Miksi pyyntö hylättiin, pysyvänä koodina, jonka mukaan voit haarautua: esimerkiksi insufficient_scope (403), rate_limited (429) ja käytön mukaan laskutettavalle asiakkaalle spend_cap_reached (402) ja metered_billing_inactive (402).

errorstringpakollinen

Sanasto

Luo sanastolistoja oppijan tasolla.

• Luo sanastolista POST /v1/vocab/stream

Tuntisuunnitelmat

Luo tuntisuunnitelmia, lue niitä ja yhdistä uudelleen suunnitelmaan, jota vielä luodaan.

• Luo tuntisuunnitelma POST /v1/lesson-plans
• Hae tuntisuunnitelma GET /v1/lesson-plans/{id}
• Yhdistä uudelleen tuntisuunnitelmaan GET /v1/lesson-plans/{id}/stream

Tutor

Käy keskustelua kielitutorin kanssa vuoro kerrallaan.

• Lähetä tutorvuoro POST /v1/tutor/message

Tapahtumat

Lue tililläsi tapahtuvat tapahtumat sivu kerrallaan tai virtana.

• Listaa tapahtumat GET /v1/events
• Lähetä tapahtuma POST /v1/events
• Suoratoista tapahtumat GET /v1/events/stream

Tili

Katso, paljonko kiintiöstäsi on jäljellä.

• Hae jäljellä oleva kiintiösi GET /v1/usage

Viite

Tämä asiakirja koneluettavassa muodossa.

• Hae tämä asiakirja GET /v1/openapi.json
• Hae tapahtuma-asiakirja GET /v1/asyncapi.json
• Luettele API-versiot GET /v1/versions
• Hae API-versio GET /v1/versions/{id}

Tapahtumaluettelo

Lingara kirjaa tilisi tuntisuunnitelmissa ja käytössä tapahtuvat asiat tapahtumiksi ja ottaa vastaan tapahtumia pelistäsi tai sovelluksestasi. Jokaisella tapahtumalla on sama kirjekuori kulkutavasta riippumatta, ja tapahtumaluettelo luettelee ne kaikki. Webhookit ja tapahtumat

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

• Sinä → Lingara world.context_changed
• Sinä → Lingara world.practice_requested