ឯកសារយោង Lingara API

កំណែ API 2026-10-affable-towhee

បង្កើតបញ្ជីវាក្យសព្ទ និងផែនការមេរៀន ហើយសន្ទនាជាមួយគ្រូបង្រៀន ជាភាសាដែល Lingara បង្រៀន។ ការហៅនីមួយៗត្រូវបានបង់ដោយ client ដែលធ្វើការហៅនោះ៖ client allowance ប្រើប្រាស់កូតារបស់ម្ចាស់វា ហើយ client metered ត្រូវបានគិតប្រាក់តាមការប្រើប្រាស់របស់វា។

ចូលចិត្តបណ្ណាល័យមែនទេ? សូមមើលផ្នែកបណ្ណាល័យ។

URL មូលដ្ឋាន https://api.getlingara.com

token ចូលប្រើ OAuth 2.0 ដែលផ្ញើជា Authorization: Bearer <token>។ ម៉ាស៊ីនមេដែលធ្វើសកម្មភាពក្នុងនាមខ្លួនឯង ប្តូរ id និងអាថ៌កំបាំងនៃម៉ាស៊ីនភ្ញៀវរបស់វានៅ URL token (client_credentials)។ កម្មវិធីដែលធ្វើសកម្មភាពជំនួសអ្នកប្រើ Lingara ដែលយល់ព្រម ប្រើកូដអនុញ្ញាត (authorization_code) ហើយបន្ទាប់មកធ្វើឱ្យស្រស់។ token មួយមានសុពលភាពមួយម៉ោង។ ប្រតិបត្តិការនីមួយៗត្រូវការវិសាលភាពមួយ។

URL ថូខឹន https://api.getlingara.com/oauth/token

វិសាលភាព
`vocab:generate`	បង្កើតបញ្ជីវាក្យសព្ទ។	បង្កើតបញ្ជីវាក្យសព្ទ
`lesson_plans:read`	អានផែនការមេរៀនរបស់អ្នក ហើយភ្ជាប់ឡើងវិញទៅវឌ្ឍនភាពរបស់វា។	ទទួលផែនការមេរៀន ភ្ជាប់ឡើងវិញទៅផែនការមេរៀន
`lesson_plans:write`	បង្កើតផែនការមេរៀន។	បង្កើតផែនការមេរៀន
`tutor:converse`	សន្ទនាជាមួយគ្រូបង្រៀន។ តម្រូវឱ្យមានគម្រោងបង់ប្រាក់។	ផ្ញើវេនមួយទៅគ្រូបង្រៀន
`usage:read`	មើលកូតាដែលនៅសល់របស់អ្នក ឬការប្រើប្រាស់ខែនេះរបស់ client `metered`។	ទទួលកូតាដែលនៅសល់របស់អ្នក
`events:read`	អានព្រឹត្តិការណ៍អំពីគណនីរបស់អ្នក ហើយចុះឈ្មោះចំណុចបញ្ចប់ដែលទទួលព្រឹត្តិការណ៍ទាំងនោះ។	រាយព្រឹត្តិការណ៍ស្ទ្រីមព្រឹត្តិការណ៍
`events:write`	ផ្ញើព្រឹត្តិការណ៍ពីហ្គេម ឬការរួមបញ្ចូលរបស់អ្នកទៅ Lingara។	ផ្ញើព្រឹត្តិការណ៍

កំហុស

402application/json: ការហៅរបស់ក្លាយអិនត៍ដែលគិតថ្លៃតាមការប្រើប្រាស់ត្រូវបានបដិសេធ មុនពេលវាចំណាយអ្វីទាំងអស់។ spend_cap_reached៖ ក្លាយអិនត៍ ឬគណនីរបស់វាបានដល់កម្រិតចំណាយប្រចាំខែរបស់វាហើយ សូមដំឡើងកម្រិតនៅលើទំព័រ ការតភ្ជាប់។ metered_billing_inactive៖ ការគិតថ្លៃតាមការប្រើប្រាស់មិនទាន់សកម្មសម្រាប់គណនីនេះទេ សូមរៀបចំវា ឬធ្វើបច្ចុប្បន្នភាពវិធីបង់ប្រាក់ នៅលើទំព័រ ការតភ្ជាប់។
410application/json: កំណែ API ដែលប្រើឆ្លើយសំណើនេះត្រូវបានបញ្ឈប់ហើយ។ សូមផ្ញើកំណែដែលគាំទ្រនៅក្នុង Lingara-Version ឬភ្ជាប់ម៉ាស៊ីនភ្ញៀវទៅកំណែផ្សេង។
4XXapplication/json: សំណើត្រូវបានបដិសេធ។ code ប្រាប់មូលហេតុ ហើយ error ពន្យល់វាជាពាក្យ។
503application/json · text/plain: សេវាកម្មមិនអាចប្រើបានជាបណ្តោះអាសន្ន; សូមព្យាយាមម្តងទៀតបន្ទាប់ពីចំនួនវិនាទីក្នុង Retry-After។ ក្នុងពេលថែទាំ ខ្លឹមសារជាអត្ថបទធម្មតា មិនមែនជាស្រោមកំហុសទេ។
5XXapplication/json: សំណើត្រូវបានបដិសេធ។ code ប្រាប់មូលហេតុ ហើយ error ពន្យល់វាជាពាក្យ។

codestringចាំបាច់: មូលហេតុដែលសំណើត្រូវបានបដិសេធ ជាកូដថេរសម្រាប់បែងចែកតក្កវិជ្ជា៖ ឧទាហរណ៍ insufficient_scope (403), rate_limited (429) ហើយសម្រាប់ក្លាយអិនត៍ដែលគិតថ្លៃតាមការប្រើប្រាស់ spend_cap_reached (402) និង metered_billing_inactive (402)។
errorstringចាំបាច់

វាក្យសព្ទ

បង្កើតបញ្ជីវាក្យសព្ទតាមកម្រិតរបស់អ្នករៀន។

បង្កើតបញ្ជីវាក្យសព្ទ POST /v1/vocab/stream

ផែនការមេរៀន

បង្កើតផែនការមេរៀន អានវា ហើយភ្ជាប់ឡើងវិញទៅផែនការដែលកំពុងបង្កើតនៅឡើយ។

បង្កើតផែនការមេរៀន POST /v1/lesson-plans
ទទួលផែនការមេរៀន GET /v1/lesson-plans/{id}
ភ្ជាប់ឡើងវិញទៅផែនការមេរៀន GET /v1/lesson-plans/{id}/stream

គ្រូបង្រៀន

សន្ទនាជាមួយគ្រូបង្រៀនភាសា ម្តងមួយវេន។

ផ្ញើវេនមួយទៅគ្រូបង្រៀន POST /v1/tutor/message

ព្រឹត្តិការណ៍

អានព្រឹត្តិការណ៍ដែលកើតឡើងក្នុងគណនីរបស់អ្នក ម្តងមួយទំព័រ ឬជាស្ទ្រីម។

រាយព្រឹត្តិការណ៍ GET /v1/events
ផ្ញើព្រឹត្តិការណ៍ POST /v1/events
ស្ទ្រីមព្រឹត្តិការណ៍ GET /v1/events/stream

គណនី

មើលថាកូតារបស់អ្នកនៅសល់ប៉ុន្មាន។

ទទួលកូតាដែលនៅសល់របស់អ្នក GET /v1/usage

ឯកសារយោង

ឯកសារនេះ ក្នុងទម្រង់ដែលម៉ាស៊ីនអាចអានបាន។

ទទួលឯកសារនេះ GET /v1/openapi.json
ទទួលឯកសារព្រឹត្តិការណ៍ GET /v1/asyncapi.json
រាយកំណែ API GET /v1/versions
ទទួលកំណែ API មួយ GET /v1/versions/{id}

បញ្ជីព្រឹត្តិការណ៍

Lingara កត់ត្រាអ្វីដែលកើតឡើងចំពោះផែនការមេរៀន និងការប្រើប្រាស់នៃគណនីរបស់អ្នក ជាព្រឹត្តិការណ៍ ហើយទទួលព្រឹត្តិការណ៍ពីហ្គេម ឬកម្មវិធីរបស់អ្នក។ ព្រឹត្តិការណ៍នីមួយៗ មិនថាធ្វើដំណើរតាមផ្លូវណាទេ មានស្រោមសំបុត្រដូចគ្នា ហើយកាតាឡុកព្រឹត្តិការណ៍រាយបញ្ជីពួកវាទាំងអស់។ Webhook និងព្រឹត្តិការណ៍

Lingara → អ្នក lesson_plan.ready
Lingara → អ្នក lesson_plan.failed
Lingara → អ្នក usage.threshold_reached
Lingara → អ្នក webhook.test
Lingara → អ្នក app.installed
Lingara → អ្នក app.uninstalled

អ្នក → Lingara world.context_changed
អ្នក → Lingara world.practice_requested

ប្រសិនបើការបកប្រែ និងឯកសារយោងជាភាសាអង់គ្លេសខុសគ្នា ឯកសារយោងជាភាសាអង់គ្លេសគឺជាឯកសារដែលត្រឹមត្រូវ។