សោ API

សោ API អនុញ្ញាតឱ្យកម្មវិធីខាងក្រៅចូលប្រើទិន្នន័យ OKPaid របស់អ្នក។ ប្រើវាដើម្បីភ្ជាប់ប្រព័ន្ធលក់ ឧបករណ៍គ្រប់គ្រងស្តុក ឬកម្មវិធីផ្ទាល់ខ្លួនរបស់អ្នក។

មុននឹងចាប់ផ្តើម

• អ្នកត្រូវមានតួនាទី ម្ចាស់ ឬ អ្នកគ្រប់គ្រង ដើម្បីគ្រប់គ្រងសោ API

មើលសោ API

1. ចុច ក្រុមការងារ ក្នុងម៉ឺនុយចំហៀង
2. ចុច សោ API
3. អ្នកនឹងឃើញបញ្ជីសោ API របស់អ្នក

បញ្ជីបង្ហាញ៖

ជួរឈរ	ការពិពណ៌នា
ឈ្មោះ	ឈ្មោះដែលអ្នកបានដាក់ឱ្យសោ
សោ	តួអក្សរដំបូងនៃសោ (សោពេញត្រូវបានលាក់)
សិទ្ធិ	អ្វីដែលសោអាចចូលប្រើ
បង្កើតនៅ	ពេលដែលសោត្រូវបានបង្កើត
ប្រើចុងក្រោយ	ពេលដែលសោត្រូវបានប្រើចុងក្រោយ
ស្ថានភាព	សកម្ម ឬ បិទ

បង្កើតសោ API

1. ចូលទៅ ក្រុមការងារ > សោ API
2. ចុច បង្កើតសោ API
3. បញ្ចូលឈ្មោះសម្រាប់សោ
4. ជ្រើសរើសសិទ្ធិដែលសោត្រូវការ
5. ចុច បង្កើត

ជ្រើសឈ្មោះឱ្យបានល្អ

ប្រើឈ្មោះដែលពិពណ៌នាថាសោនេះសម្រាប់អ្វី។ ឧទាហរណ៍ល្អ៖

• “រួមបញ្ចូល POS”
• “សមកាលកម្មស្តុក”
• “នាំចេញគណនេយ្យ”

ជ្រើសរើសសិទ្ធិ

ជ្រើសរើសតែសិទ្ធិដែលការរួមបញ្ចូលរបស់អ្នកត្រូវការ។ វាមានសុវត្ថិភាពជាងការផ្តល់សិទ្ធិពេញលេញ។

សិទ្ធិ	អ្វីដែលអនុញ្ញាត
ផលិតផល៖ អាន	មើលព័ត៌មានផលិតផល
ផលិតផល៖ បង្កើត	បន្ថែមផលិតផលថ្មី
ផលិតផល៖ អាប់ដេត	កែសម្រួលផលិតផលដែលមានស្រាប់
ផលិតផល៖ លុប	ដកផលិតផលចេញ
ការលក់៖ អាន	មើលការបញ្ជាទិញ និងការលក់
ការលក់៖ បង្កើត	បង្កើតការបញ្ជាទិញថ្មី
ការលក់៖ អាប់ដេត	កែសម្រួលការបញ្ជាទិញ
អតិថិជន៖ អាន	មើលព័ត៌មានអតិថិជន
អតិថិជន៖ បង្កើត	បន្ថែមអតិថិជនថ្មី
អតិថិជន៖ អាប់ដេត	កែសម្រួលព័ត៌មានអតិថិជន
អតិថិជន៖ លុប	ដកអតិថិជនចេញ
អ្នកផ្គត់ផ្គង់៖ អាន	មើលព័ត៌មានអ្នកផ្គត់ផ្គង់
អ្នកផ្គត់ផ្គង់៖ បង្កើត	បន្ថែមអ្នកផ្គត់ផ្គង់ថ្មី
អ្នកផ្គត់ផ្គង់៖ អាប់ដេត	កែសម្រួលព័ត៌មានអ្នកផ្គត់ផ្គង់
អ្នកផ្គត់ផ្គង់៖ លុប	ដកអ្នកផ្គត់ផ្គង់ចេញ

គន្លឹះ: ចាប់ផ្តើមដោយសិទ្ធិអានតែប៉ុណ្ណោះ។ បន្ថែមសិទ្ធិផ្សេងទៀតនៅពេលក្រោយ បើចាំបាច់។

របៀបដែលសិទ្ធិដំណើរការ

សោ API មានសិទ្ធិផ្ទាល់ខ្លួន។ សិទ្ធិទាំងនេះដោយឡែកពីសិទ្ធិគណនីអ្នកប្រើប្រាស់របស់អ្នក។

នេះមានន័យថា៖

• សោ API របស់អ្នកអាចធ្វើបានតែអ្វីដែលអ្នកអនុញ្ញាត
• បើសោគ្មានសិទ្ធិ សំណើនឹងត្រូវបានរារាំង
• សិទ្ធិគណនីអ្នកប្រើប្រាស់របស់អ្នកមិនប៉ះពាល់ដល់សិទ្ធិសោ API ទេ

ឧទាហរណ៍ទី 1: សោអានតែប៉ុណ្ណោះ សោ API ដែលមានសិទ្ធិតែ “ផលិតផល៖ អាន” អាច៖

• ✅ មើលព័ត៌មានផលិតផល
• ❌ បង្កើតផលិតផលថ្មី
• ❌ កែសម្រួលផលិតផល
• ❌ លុបផលិតផល

ឧទាហរណ៍ទី 2: សោសម្រាប់តែផលិតផល សោ API ដែលមានតែសិទ្ធិផលិតផល អាច៖

• ✅ មើល បង្កើត កែសម្រួល និងលុបផលិតផល
• ❌ មើលអតិថិជន
• ❌ មើលការលក់
• ❌ មើលអ្នកផ្គត់ផ្គង់

ឧទាហរណ៍ទី 3: សោសិទ្ធិពេញលេញ សោ API ដែលមានសិទ្ធិទាំងអស់ អាច៖

• ✅ មើល បង្កើត កែសម្រួល និងលុបផលិតផល
• ✅ មើល បង្កើត និងកែសម្រួលការលក់
• ✅ មើល បង្កើត កែសម្រួល និងលុបអតិថិជន
• ✅ មើល បង្កើត កែសម្រួល និងលុបអ្នកផ្គត់ផ្គង់

ចម្លងសោ API របស់អ្នក

បន្ទាប់ពីអ្នកបង្កើតសោ OKPaid បង្ហាញវាតែម្តង។ សូមចម្លងវាភ្លាមៗ។

សំខាន់: អ្នកនឹងលែងឃើញសោពេញទៀតទេ។ បើអ្នកបាត់វា អ្នកត្រូវបង្កើតសោថ្មី។

រក្សាទុកសោដោយសុវត្ថិភាព

• រក្សាទុកសោក្នុងកម្មវិធីគ្រប់គ្រងពាក្យសម្ងាត់
• មិនត្រូវចែករំលែកសោក្នុងអ៊ីមែល ឬការសន្ទនាទេ
• មិនត្រូវដាក់សោក្នុងកូដដែលអ្នកផ្សេងអាចមើលឃើញទេ
• រក្សាសោជាការសម្ងាត់ ដូចពាក្យសម្ងាត់

ប្រើសោ API របស់អ្នក

ដើម្បីប្រើសោ API របស់អ្នក សូមបន្ថែមវាទៅសំណើ API ជា header៖

x-api-key: okp_your_api_key_here

សោចាប់ផ្តើមដោយ okp_ បន្តដោយតួអក្សរចៃដន្យ។

ឧទាហរណ៍សំណើ

curl -H "x-api-key: okp_abc123..." \
     https://api.okpaid.io/api/v1/products

ដែនកំណត់អត្រាសំណើ

សោ API នីមួយៗមានដែនកំណត់អត្រា ដើម្បីការពារការប្រើប្រាស់ខុស៖

ដែនកំណត់	តម្លៃ
សំណើក្នុងមួយថ្ងៃ	1,000
សំណើក្នុងមួយនាទី	60

បើអ្នកលើសដែនកំណត់ អ្នកនឹងទទួលបានកំហុស 429 Too Many Requests។ សូមរង់ចាំ ហើយព្យាយាមម្តងទៀតនៅពេលក្រោយ។

កែសម្រួលសោ API

1. ចូលទៅ ក្រុមការងារ > សោ API
2. រកសោដែលអ្នកចង់កែសម្រួល
3. ចុចលើឈ្មោះសោ ឬប៊ូតុងកែសម្រួល
4. ធ្វើការផ្លាស់ប្តូររបស់អ្នក
5. ចុច រក្សាទុក

អ្នកអាចផ្លាស់ប្តូរ៖

• ឈ្មោះសោ
• បើក ឬបិទសោ
• បន្ថែម ឬដកសិទ្ធិចេញ

អ្នកមិនអាចផ្លាស់ប្តូរតួសោខ្លួនវាបានទេ។ ដើម្បីទទួលសោថ្មី សូមដកហូតសោនេះ រួចបង្កើតសោថ្មី។

បិទសោ API

ដើម្បីបញ្ឈប់សោជាបណ្តោះអាសន្ន៖

1. ចូលទៅ ក្រុមការងារ > សោ API
2. ចុចលើសោ
3. ប្តូរ បើកដំណើរការ ទៅជាបិទ
4. ចុច រក្សាទុក

សោនឹងឈប់ដំណើរការភ្លាមៗ។ អ្នកអាចបើកវាឡើងវិញនៅពេលក្រោយ។

លុបសោ API

ដើម្បីលុបសោចេញជាអចិន្ត្រៃយ៍៖

1. ចូលទៅ ក្រុមការងារ > សោ API
2. ចុចលើសោ
3. ចុច ដកហូតសោ
4. បញ្ជាក់ការលុប

ការព្រមាន: ការលុបសោត្រឡប់វិញមិនបានទេ។ កម្មវិធីណាដែលប្រើសោនេះនឹងឈប់ដំណើរការ។

គន្លឹះសុវត្ថិភាព

គន្លឹះ: ផ្លាស់ប្តូរសោរបស់អ្នកជាប្រចាំ។ ដកហូតសោចាស់ ហើយបង្កើតសោថ្មី រាល់ពីរបីខែម្តង។

គន្លឹះ: ប្រើសោផ្សេងគ្នាសម្រាប់កម្មវិធីផ្សេងគ្នា។ វិធីនេះ អ្នកអាចបិទសោមួយ ដោយមិនប៉ះពាល់ដល់សោផ្សេងទៀត។

គន្លឹះ: ពិនិត្យ “ប្រើចុងក្រោយ” ជាប្រចាំ។ បើសោបង្ហាញសកម្មភាពមិនប្រក្រតី សូមបិទវាភ្លាមៗ។

គន្លឹះ: ដកហូតសោដែលអ្នកលែងប្រើ។

សំណួរទូទៅ

តើខ្ញុំអាចមើលសោ API ពេញ បន្ទាប់ពីបង្កើតវាបានទេ? មិនបានទេ។ OKPaid បង្ហាញសោតែម្តងប៉ុណ្ណោះ។ បើអ្នកបាត់វា សូមបង្កើតសោថ្មី។

តើខ្ញុំអាចផ្លាស់ប្តូរសោ API បានទេ? មិនបានទេ។ អ្នកអាចផ្លាស់ប្តូរបានតែឈ្មោះ និងសិទ្ធិប៉ុណ្ណោះ។ ដើម្បីទទួលសោថ្មី សូមដកហូតសោចាស់ រួចបង្កើតសោថ្មី។

តើមានអ្វីកើតឡើង បើនរណាម្នាក់បានសោ API របស់ខ្ញុំ? សូមដកហូតសោនោះភ្លាមៗ។ រួចបង្កើតសោថ្មីសម្រាប់កម្មវិធីរបស់អ្នក។

តើសោ API អាចគ្រប់គ្រងសមាជិកក្រុម ឬការកំណត់បានទេ? មិនបានទេ។ សោ API អាចចូលប្រើបានតែផលិតផល ការលក់ អតិថិជន និងអ្នកផ្គត់ផ្គង់ប៉ុណ្ណោះ។ វាមិនអាចគ្រប់គ្រងក្រុមការងាររបស់អ្នកបានទេ។

ហេតុអ្វីសោ API របស់ខ្ញុំមិនដំណើរការ? សូមពិនិត្យថា៖

• សោនោះបានបើកដំណើរការ
• អ្នកកំពុងប្រើសោត្រឹមត្រូវ
• អ្នកមិនបានលើសដែនកំណត់អត្រាសំណើ
• សោនោះមានសិទ្ធិដែលអ្នកត្រូវការ

ហេតុអ្វីខ្ញុំឃើញកំហុស “Insufficient permissions”?

កំហុសនេះមានន័យថាសោ API របស់អ្នកគ្មានសិទ្ធិសម្រាប់អ្វីដែលអ្នកកំពុងព្យាយាមធ្វើ។

មូលហេតុទូទៅ៖

• អ្នកកំពុងប្រើសោអានតែប៉ុណ្ណោះ ដើម្បីបង្កើត ឬកែទិន្នន័យ
• អ្នកកំពុងព្យាយាមចូលប្រើអតិថិជន ដោយប្រើសោសម្រាប់តែផលិតផល
• អ្នកកំពុងព្យាយាមចូលប្រើអ្នកផ្គត់ផ្គង់ ដោយប្រើសោសម្រាប់តែអតិថិជន

របៀបដោះស្រាយ៖

1. ចូលទៅ ក្រុមការងារ > សោ API
2. រកសោដែលអ្នកកំពុងប្រើ
3. ចុច កែសម្រួល
4. បន្ថែមសិទ្ធិដែលអ្នកត្រូវការ
5. រក្សាទុកការផ្លាស់ប្តូរ

ឬបង្កើតសោថ្មីដែលមានសិទ្ធិត្រឹមត្រូវ។

តើសិទ្ធិសោ API ប៉ះពាល់ដល់គណនីអ្នកប្រើប្រាស់របស់ខ្ញុំទេ?

មិនទេ។ សិទ្ធិសោ API ដោយឡែកទាំងស្រុងពីសិទ្ធិគណនីអ្នកប្រើប្រាស់របស់អ្នក។

• សិទ្ធិគណនីអ្នកប្រើប្រាស់របស់អ្នកដំណើរការពេលអ្នកចូលគណនីលើគេហទំព័រ OKPaid
• សិទ្ធិសោ API ដំណើរការតែពេលប្រើសោ API ក្នុងកូដ ឬកម្មវិធីរបស់អ្នកប៉ុណ្ណោះ
• ការផ្លាស់ប្តូរសិទ្ធិសោ API មិនផ្លាស់ប្តូរគណនីអ្នកប្រើប្រាស់របស់អ្នកទេ
• ការផ្លាស់ប្តូរគណនីអ្នកប្រើប្រាស់របស់អ្នក មិនផ្លាស់ប្តូរសិទ្ធិសោ API ទេ

ស្រមៃថាដូចជាមានសោពីរផ្សេងគ្នាសម្រាប់អគារមួយ។ គណនីអ្នកប្រើប្រាស់របស់អ្នកជាសោមួយ។ សោ API របស់អ្នកជាសោមួយទៀត។ សោនីមួយៗបើកទ្វារផ្សេងគ្នា។

ត្រូវការជំនួយ?

បើអ្នកមានបញ្ហាជាមួយសោ API៖

1. ពិនិត្យមគ្គុទ្ទេសក៍នេះសម្រាប់បញ្ហាទូទៅ
2. ទាក់ទងក្រុមគាំទ្រ ដោយប្រាប់ឈ្មោះសោ (មិនមែនសោពេញ)

ជំហានបន្ទាប់

• មគ្គុទ្ទេសក៍ផលិតផល - រៀនពីការគ្រប់គ្រងផលិតផល
• មគ្គុទ្ទេសក៍ការបញ្ជាទិញ - រៀនពីការគ្រប់គ្រងការបញ្ជាទិញ