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

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

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

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

cursorquerystringស្រេចចិត្ត

កន្លែងបន្ត៖ next_cursor នៃទំព័រមុន ឬ id: នៃព្រឹត្តិការណ៍ស្ទ្រីម។ ទស្សន៍ទ្រនិចចាស់ជាង 30 ថ្ងៃ ត្រូវឆ្លើយដោយ 410 ជាមួយកូដ cursor_expired។

startquerystringស្រេចចិត្ត

កន្លែងចាប់ផ្តើមដោយគ្មានទស្សន៍ទ្រនិច៖ latest សម្រាប់ព្រឹត្តិការណ៍ចាប់ពីពេលនេះ ឬ oldest សម្រាប់ព្រឹត្តិការណ៍ទាំងអស់ដែលនៅរក្សាទុក។

typesqueryarray of stringស្រេចចិត្ត

តែប្រភេទព្រឹត្តិការណ៍ទាំងនេះ បំបែកដោយសញ្ញាក្បៀស។ បើគ្មាន គឺគ្រប់ប្រភេទដែលវិសាលភាពនៃថូខឹនរបស់អ្នកអាចអានបាន។

limitqueryintegerស្រេចចិត្ត

ចំនួនព្រឹត្តិការណ៍ច្រើនបំផុតដែលទំព័រមួយត្រឡប់ ពី 1 ដល់ 100។

ការឆ្លើយតប

200 ទំព័រព្រឹត្តិការណ៍មួយ និងទស្សន៍ទ្រនិចសម្រាប់បន្ត

itemsarray of EventEnvelopeចាំបាច់

idstringចាំបាច់

typestringចាំបាច់

created_atstringចាំបាច់

api_versionstringចាំបាច់

subjectstringចាំបាច់

dataobjectចាំបាច់

next_cursorstringចាំបាច់

has_morebooleanចាំបាច់

កំហុស

410application/json

api_version_discontinued៖ កំណែ API នៃសំណើនេះត្រូវបានបញ្ឈប់។ cursor_expired៖ ទស្សន៍ទ្រនិចចាស់ជាង 30 ថ្ងៃ។ ចាប់ផ្តើមម្តងទៀតដោយគ្មានវា។

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 "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

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