ข้ามไปยังเนื้อหาหลัก

API Key Management

ฟีเจอร์ API Key Management ช่วยให้ผู้ดูแลสร้างและจัดการ systems ที่เป็นเจ้าของ API keys สำหรับเชื่อมต่อ tenant กับ external applications แต่ละ system แทน client application ที่ลงทะเบียนไว้และต้องใช้การยืนยันตัวตนกับ Consentrix API

Prerequisites​

ก่อนเริ่มต้น ตรวจสอบว่าคุณมี:

  • Consentrix Account ที่ใช้งานได้
  • สิทธิ์สำหรับจัดการ API keys ที่เหมาะสม ดูรายละเอียดใน Required Permissions

Required Permissions​

Permission CodeAccess
api_key_management:viewดู systems และ API keys
api_key_management:createสร้าง systems และ generate API keys
api_key_management:editแก้ชื่อ system และ revoke API keys
api_key_management:deleteลบ systems

Key Features​

FeatureDescription
Create Systemสร้าง system API entry ใหม่สำหรับ tenant
Edit Systemแก้ไขชื่อ system
Generate API Keyสร้าง API key ที่ปลอดภัย โดยระบบจะแสดง full key เพียงครั้งเดียว
Revoke API Keyยกเลิกการใช้งาน API key เดิม
Delete Systemลบ system และ API key ของ system นั้น
Searchค้นหา systems ตามชื่อ
  1. Log in เข้า Consentrix platform
  2. ไปที่ Administration > API Key Management

คุณจะเห็นรายการ systems ทั้งหมดของ tenant พร้อมชื่อ, API key mark (4 ตัวท้าย) และเวลาอัปเดตล่าสุด

API Key Management List

Create a New System​

System คือ API client ที่ลงทะเบียนไว้และจะเป็นเจ้าของ API key สำหรับยืนยันตัวตนกับ Consentrix API

Steps​

  1. ที่หน้า API Key Management คลิก Create API key
  2. ที่หน้า Create System:
    • กรอก System Name ที่ไม่ซ้ำกัน เช่น mobile-app-ios, checkout-service, crm-integration
  3. คลิก Submit
  4. ระบบจะพาคุณไปที่หน้า System Detail

Create System Page

Tip: ใช้ชื่อที่สื่อชัดว่า application หรือ service ไหนเป็นผู้ใช้ API key นี้ จะช่วยให้ตรวจสอบและ audit ได้ง่ายขึ้น

View System Details​

หน้า System Detail จะแสดงข้อมูลของ system ที่เลือก:

FieldDescription
System Nameชื่อของ system
API Key Mark4 ตัวท้ายของ API key หรือแสดงเป็น "Not generated"
Last Updatedเวลาที่มีการแก้ไขล่าสุด

จากหน้านี้ คุณสามารถ:

  • จัดการ API Key ทั้ง generate หรือ revoke
  • แก้ชื่อ system
  • ลบ system

System Detail Page

Manage API Key​

จากหน้า System Detail คลิก Manage API Key เพื่อไปยังหน้าจัดการ API key

Manage API Key Page

Generate an API Key​

เมื่อสร้าง system แล้ว คุณสามารถ generate API key สำหรับ system นั้นได้

Steps​

  1. จากหน้า Manage API Key คลิก Generate API Key
  2. ระบบจะแสดง dialog ที่มี full API key และ key mark (4 ตัวท้าย)
  3. สำคัญ: คัดลอก API key ทันทีและเก็บไว้ในที่ปลอดภัย เพราะ full key จะแสดง เพียงครั้งเดียว
  4. คลิก Close เพื่อปิด dialog

Generate API Key Dialog

What happens next​

  • API key mark เช่น ••••••••••••abcd จะมองเห็นได้ใน system list เพื่อใช้แยกแยะ key
  • Full API key จะไม่สามารถเปิดดูซ้ำได้ หากทำหายต้อง revoke แล้ว generate ใหม่

Security Best Practices​

  • เก็บ API key ไว้ใน secrets manager ของ application หรือ environment variables
  • ห้าม hard-code API key ใน source code หรือ commit ลง repository
  • แยก system ต่อ application หรือ service อย่าใช้ key เดียวร่วมกันหลายบริการ

Edit a System​

คุณสามารถแก้ชื่อของ system ที่มีอยู่แล้วได้

Steps​

  1. จากรายการ API Key Management คลิก View ที่ system ที่ต้องการแก้
  2. ที่หน้า System Detail คลิก Edit
  3. แก้ System Name ตามต้องการ
  4. คลิก Save
  5. ยืนยันการเปลี่ยนแปลง

Edit System Page

Revoke an API Key​

การ revoke API key จะทำให้ key นั้นใช้งานไม่ได้ทันที เหมาะสำหรับกรณีที่สงสัยว่า key รั่วไหล หรือ application นั้นไม่ได้ใช้งานแล้ว

Steps​

  1. จากหน้า Manage API Key คลิก Revoke API Key
  2. ระบบจะแสดง confirmation dialog ว่า API key ปัจจุบันจะไม่สามารถใช้งานต่อได้
  3. คลิก Confirm เพื่อ revoke key

Revoke API Key Dialog

Note: หลัง revoke แล้ว system จะแสดง "Not generated" ในช่อง API key mark และคุณสามารถ generate key ใหม่ได้หากจำเป็น

Delete a System​

การลบ system จะลบ system นั้นและ API key ที่เกี่ยวข้องออกจากระบบถาวร

Steps​

  1. จากหน้า System Detail คลิก Delete System
  2. ระบบจะแสดง confirmation dialog
  3. คลิก Confirm เพื่อลบ system

Delete System Dialog

Warning: การกระทำนี้ย้อนกลับไม่ได้ ควรตรวจสอบก่อนว่าไม่มี application ใดกำลังใช้ API key ของ system นี้อยู่

Search for Systems​

คุณสามารถกรองรายการ systems ตามชื่อได้:

  1. ใน search bar ด้านบนของหน้า API Key Management ให้พิมพ์ชื่อ system บางส่วนหรือทั้งหมด
  2. ตารางจะแสดงเฉพาะรายการที่ตรงเงื่อนไข
  3. ล้างคำค้นเพื่อดู systems ทั้งหมดอีกครั้ง

Best Practices​

System Naming Conventions​

ใช้ชื่อที่ชัดเจนและสื่อถึง application หรือ service:

Good ExamplesAvoid
mobile-app-iosapp1
checkout-serviceapi
crm-integrationsystem

API Key Security​

  1. Store Securely: เก็บ API keys ใน secrets manager หรือ environment variables
  2. Never Commit: อย่า hard-code API keys ใน source code หรือ commit ลง repository
  3. One Key Per Service: แยก system ต่อ application แทนการแชร์ key ระหว่าง services
  4. Rotate Regularly: revoke และ generate key ใหม่เป็นระยะ หรือเมื่อมีการเปลี่ยนสมาชิกทีม
  5. Monitor Usage: ใช้ Audit Log เพื่อติดตามกิจกรรมที่เกี่ยวกับ API key และมองหารูปแบบที่ผิดปกติ

Lifecycle Management​

  1. Document Systems: เก็บรายการ systems ภายในองค์กรพร้อมวัตถุประสงค์ของแต่ละตัว
  2. Review Periodically: ตรวจสอบ systems เป็นระยะ และลบตัวที่ไม่ได้ใช้งานแล้ว
  3. Revoke Promptly: revoke keys ทันทีเมื่อ application ถูก decommission

Troubleshooting​

"Generate API Key" button is disabled​

  • system นี้มี API key ถูก generate ไปแล้ว ถ้าต้องการ key ใหม่ให้ revoke key เดิมก่อน

"Revoke API Key" button is disabled​

  • system นี้ยังไม่มีการ generate API key

Cannot see "Create API key" button​

  • บัญชีของคุณไม่มีสิทธิ์ api_key_management:create ให้ติดต่อ administrator
  • API Key Management Guide - จัดการ API keys ใน portal
  • Role & Permission Guide - จัดการสิทธิ์ของผู้ใช้ รวมถึงสิทธิ์สำหรับ API key management
  • Audit Log - ติดตามกิจกรรมที่เกี่ยวข้องกับ API key management
  • Identity & Access - ทำความเข้าใจ systems, API keys, users, roles และ tenant scope