Sanggunian ng Lingara API

Mga error

402application/json

Tinanggihan ang tawag ng isang metered client bago ito nakagastos ng anuman. spend_cap_reached: naabot na ng client o ng account nito ang buwanang limitasyon sa paggastos; itaas ang limitasyon sa pahinang Mga integration. metered_billing_inactive: hindi aktibo ang usage billing para sa account na ito; i-set up ito, o i-update ang paraan ng pagbabayad, sa pahinang Mga integration.

410application/json

Itinigil na ang bersyon ng API na ginagamit sa pagsagot sa kahilingang ito. Magpadala ng suportadong bersyon sa Lingara-Version, o i-pin ang client sa ibang bersyon.

4XXapplication/json

Tinanggihan ang kahilingan. Sinasabi ng code kung bakit, at ipinapaliwanag ito ng error sa mga salita.

503application/json · text/plain

Pansamantalang hindi available ang serbisyo; subukang muli pagkatapos ng bilang ng segundong nasa Retry-After. Habang may maintenance, plain text ang body sa halip na ang error envelope.

5XXapplication/json

Tinanggihan ang kahilingan. Sinasabi ng code kung bakit, at ipinapaliwanag ito ng error sa mga salita.

codestringkailangan

Kung bakit tinanggihan ang request, bilang isang matatag na code na mapagbabatayan ng iyong programa: halimbawa insufficient_scope (403), rate_limited (429) at, para sa isang metered client, spend_cap_reached (402) at metered_billing_inactive (402).

errorstringkailangan

Bokabularyo

Gumawa ng mga listahan ng bokabularyo ayon sa antas ng mag-aaral.

• Gumawa ng listahan ng bokabularyo POST /v1/vocab/stream

Mga lesson plan

Gumawa ng mga lesson plan, basahin ang mga ito, at muling kumonekta sa isang ginagawa pa.

• Gumawa ng lesson plan POST /v1/lesson-plans
• Kunin ang isang lesson plan GET /v1/lesson-plans/{id}
• Muling kumonekta sa isang lesson plan GET /v1/lesson-plans/{id}/stream

Tutor

Makipag-usap sa tutor ng wika, isang palitan sa bawat pagkakataon.

• Magpadala ng palitan sa tutor POST /v1/tutor/message

Mga event

Basahin ang mga event na nangyayari sa iyong account, isang pahina sa bawat pagkakataon o bilang stream.

• Ilista ang mga event GET /v1/events
• Magpadala ng event POST /v1/events
• I-stream ang mga event GET /v1/events/stream

Account

Tingnan kung gaano pa karami ang natitira sa iyong allowance.

• Kunin ang natitira mong allowance GET /v1/usage

Sanggunian

Ang dokumentong ito, sa anyong nababasa ng makina.

• Kunin ang dokumentong ito GET /v1/openapi.json
• Kunin ang dokumento ng mga event GET /v1/asyncapi.json
• Ilista ang mga bersyon ng API GET /v1/versions
• Kunin ang isang bersyon ng API GET /v1/versions/{id}

Katalogo ng mga event

Itinatala ng Lingara bilang mga event ang nangyayari sa mga lesson plan at paggamit ng iyong account, at tumatanggap ito ng mga event mula sa iyong laro o app. Iisa ang envelope ng bawat event, saanmang daan ito dumaan, at nakalista silang lahat sa katalogo ng mga event. Mga webhook at event

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

• Ikaw → Lingara world.context_changed
• Ikaw → Lingara world.practice_requested