Referansa API ya Lingara

Çewtî

402application/json

Bangeke klienteke pîvandî hat redkirin berî ku tiştek xerc bike. spend_cap_reached: klient an hesabê wê gihîştiye sînorê xercê yê mehane; sînor li rûpela Entegrasyon bilind bike. metered_billing_inactive: fatûrekirina li gorî bikaranînê ji bo vî hesabî ne çalak e; wê li rûpela Entegrasyon saz bike an rêbaza dayînê nû bike.

410application/json

Guhertoya API ya ku ev daxwaz pê tê bersivandin hate rawestandin. Guhertoyeke piştgirîkirî di Lingara-Version de bişîne, an klientê bi guhertoyeke din ve girê bide.

4XXapplication/json

Daxwaz hate redkirin. code sedemê dibêje, û error wê bi gotinan dibêje.

503application/json · text/plain

Xizmet bi demkî ne berdest e; piştî hejmara çirkeyên di Retry-After de dîsa biceribîne. Di dema lênêrînê de naverok nivîsa sade ye, ne zerfa çewtiyê.

5XXapplication/json

Daxwaz hate redkirin. code sedemê dibêje, û error wê bi gotinan dibêje.

codestringpêwîst

Çima daxwaz hat redkirin, wek kodeke domdar ku mirov li gorî wê şax dike: bo nimûne insufficient_scope (403), rate_limited (429) û, ji bo klienteke pîvandî, spend_cap_reached (402) û metered_billing_inactive (402).

errorstringpêwîst

Peyv

Li gorî asta xwendekar lîsteyên peyvan çêbike.

• Lîsteyeke peyvan çêbike POST /v1/vocab/stream

Planên dersê

Planên dersê çêbike, wan bixwîne, û ji nû ve bi planeke ku hê tê çêkirin ve girê bide.

• Planeke dersê çêbike POST /v1/lesson-plans
• Planeke dersê bistîne GET /v1/lesson-plans/{id}
• Ji nû ve bi planeke dersê ve girê bide GET /v1/lesson-plans/{id}/stream

Mamoste

Bi mamosteyê zimên re biaxive, her carê gerek.

• Gerekê ji mamoste re bişîne POST /v1/tutor/message

Bûyer

Bûyerên ku di hesabê te de diqewimin bixwîne, rûpel bi rûpel an wek herikînek.

• Bûyeran rêz bike GET /v1/events
• Bûyerekê bişîne POST /v1/events
• Bûyeran biherikîne GET /v1/events/stream

Hesab

Bibîne ka çiqas ji mafê te yê bikaranînê maye.

• Mafê xwe yê bikaranînê yê mayî bistîne GET /v1/usage

Referans

Ev belge, bi şêweyeke ku makîne dikare bixwîne.

• Vê belgeyê bistîne GET /v1/openapi.json
• Belgeya bûyeran bistîne GET /v1/asyncapi.json
• Lîsteya guhertoyên API GET /v1/versions
• Guhertoyeke API bistîne GET /v1/versions/{id}

Kataloga bûyeran

Lingara tiştên ku bi planên dersê û bikaranîna hesabê te re diqewimin wek bûyer tomar dike, û bûyeran ji lîstik an sepana te qebûl dike. Her bûyer, bi kîjan rêyê biçe bila biçe, heman zerfê digire, û kataloga bûyeran hemûyan rêz dike. Webhook û bûyer

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

• Tu → Lingara world.context_changed
• Tu → Lingara world.practice_requested