ភ្ជាប់អ្នកលេងទៅគណនី Lingara របស់គេ

ប៉ារ៉ាម៉ែត្រ

Lingara-Versionheaderstringស្រេចចិត្ត

កំណែ API ដែលត្រូវប្រើឆ្លើយសំណើនេះ។ បើគ្មានវាទេ token ចូលប្រើទទួលបានកំណែដែលម៉ាស៊ីនភ្ញៀវរបស់វាត្រូវបានភ្ជាប់ ហើយសំណើដែលគ្មាន token ទទួលបានកំណែបច្ចុប្បន្ន។ កំណែដែលកំពុងអភិវឌ្ឍអាចចូលដល់បានតែដោយដាក់ឈ្មោះវានៅទីនេះប៉ុណ្ណោះ។ កំណែដែលមិនស្គាល់ឆ្លើយតប 400 ជាមួយកូដ api_version_unknown។ GET /v1/versions បង្ហាញបញ្ជីកំណែ។

player_refpathstringចាំបាច់

player_ref ដែលអ្នកបានប្រើដើម្បីចេញថូខឹនរបស់អ្នកលេង ដោយអ៊ិនកូដភាគរយ៖ guild/42 ក្លាយជា guild%2F42។

ការឆ្លើយតប

200 ការភ្ជាប់របស់អ្នកលេង

statusLinkStatusចាំបាច់

subjectstringចាំបាច់

lgr_sub_ របស់គណនី៖ អ្វីដែលព្រឹត្តិការណ៍របស់អ្នកលេងនេះនឹងផ្ទុកចាប់ពីពេលនេះ។

previous_subjectstringចាំបាច់

lgr_sub_ របស់ភ្ញៀវ៖ អ្វីដែលព្រឹត្តិការណ៍មុនៗរបស់អ្នកលេងរក្សាទុក។ បញ្ជូនទាំងពីរទៅ player_ref តែមួយ។

linked_atstringចាំបាច់

ពេលដែលការភ្ជាប់ត្រូវបានបង្កើត។ ក្នុងចម្លើយ existing គឺពេលនៃការហៅលើកដំបូង។

scopesarray of stringចាំបាច់

ច្រើនបំផុតដែលថូខឹនសម្រាប់អ្នកលេងនេះអាចមានឥឡូវនេះ៖ អ្វីដែលគណនីបានផ្តល់សិទ្ធិ ក្នុងចំណោមវិសាលភាពដែលថូខឹនអ្នកលេងអាចផ្ទុក។

carriedobjectចាំបាច់

ជួរដែលការហៅនេះបានផ្លាស់ទៅគណនី តាមតារាង។ មានតែតារាងដែលមានចំនួនប៉ុណ្ណោះដែលបង្ហាញ។

keptobjectចាំបាច់

ជួរដែលការហៅនេះបានទុកនៅជាមួយភ្ញៀវ តាមតារាង៖ ផែនការដែលកំពុងសរសេរ ឬជួរដែលគណនីមានរួចហើយ។ ហៅម្តងទៀតពេល lesson_plans នៅទីនេះមានផែនការដែលបានបញ្ចប់។

កំហុស

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ចាំបាច់

ឧទាហរណ៍

curl -X PUT "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

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