จัดการ Secret API Keys ใน ECM
ในคู่มือนี้ คุณจะได้เรียนรู้วิธีสร้างและจัดการ Secret API Keys ใน ECM
Secret API Key คืออะไร?#
Secret API Key คือโทเค็นการพิสูจน์ตัวตน (authentication token) ที่ช่วยให้คุณสามารถเข้าถึง Admin APIs ของ Medusa ได้ คุณสามารถส่งคีย์นี้ในส่วนหัวของคำขอ (request headers) เพื่อส่งคำขอในฐานะผู้ใช้ที่เป็นผู้ดูแลระบบ (admin user) ที่ผ่านการพิสูจน์ตัวตนแล้ว ดังนั้น สิ่งสำคัญคือต้องไม่เปิดเผย Secret API Key ในโค้ดฝั่งไคลเอนต์ (client-side) หรือในที่จัดเก็บข้อมูลสาธารณะ (public repositories)
หากต้องการเรียนรู้วิธีส่ง Secret API Key ในส่วนหัวของคำขอ โปรดดูที่ API Reference
ดู Secret API Keys#
หากต้องการดู Secret API Keys ของผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบันใน ECM ให้ไปที่ Settings -> Secret API Keys
ที่นี่ คุณสามารถดูรายการ Secret API Keys ทั้งหมดของผู้ใช้ที่เข้าสู่ระบบอยู่ นอกจากนี้ยังสามารถค้นหา กรอง และจัดเรียงคีย์ API เพื่อค้นหาคีย์ที่คุณต้องการได้
สร้าง Secret API Key#
เมื่อคุณสร้าง Secret API Key คีย์นั้นจะถูกสร้างขึ้นสำหรับผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบัน
ขั้นตอนการสร้าง Secret API Key ใหม่สำหรับผู้ใช้ที่เข้าสู่ระบบอยู่ในปัจจุบัน:
- ไปที่ Settings -> Secret API Keys
- คลิกปุ่ม Create ในหัวข้อของส่วนหลัก
- ในฟอร์มที่เปิดขึ้น ให้กรอกชื่อ (title) ของ Secret API Key
- เมื่อเสร็จแล้ว ให้คลิกปุ่ม Save
- คุณจะเห็นป๊อปอัปแสดง Secret API Key ให้คัดลอกและจัดเก็บไว้ในที่ปลอดภัยก่อนปิดป๊อปอัป เนื่องจากคุณจะไม่สามารถกลับมาดูคีย์นี้ได้อีก
ดูรายละเอียดของ Secret API Key#
ขั้นตอนการดูรายละเอียดของ Secret API Key:
- ไปที่ Settings -> Secret API Keys
- คลิกที่ Secret API Key ที่ต้องการในรายการ
หน้าจอนี้จะเปิดหน้ารายละเอียดของ Secret API Key ซึ่งคุณสามารถจัดการคีย์ API ดังกล่าวได้ด้วย
สถานะของ Secret API Key#
คุณสามารถดูสถานะของ Secret API Key ได้ในหัวข้อของส่วนแรกในหน้ารายละเอียด สถานะของ Secret API Key สามารถเป็น:
| สถานะ | คำอธิบาย |
|---|---|
| ใช้งานอยู่ (Active) | คีย์ API นี้พร้อมใช้งานและสามารถใช้ในการส่งคำขอได้ |
| เพิกถอนแล้ว (Revoked) | คีย์ API นี้ถูกเพิกถอนแล้วและไม่สามารถใช้ในการส่งคำขอได้อีกต่อไป |
แก้ไข Secret API Key#
ขั้นตอนการแก้ไข Secret API Key:
- ไปที่หน้ารายละเอียดของ Secret API Key
- คลิกไอคอน ในหัวข้อของส่วนแรก
- เลือก "Edit" จากเมนูแบบดรอปดาวน์
- ในหน้าต่างด้านข้างที่เปิดขึ้น คุณสามารถแก้ไขชื่อ (title) ของ Secret API Key ได้
- เมื่อเสร็จแล้ว ให้คลิกปุ่ม Save
เพิกถอน Secret API Key#
ขั้นตอนการเพิกถอน Secret API Key:
- ไปที่หน้ารายละเอียดของ Secret API Key
- คลิกไอคอน ในหัวข้อของส่วนแรก
- เลือก "Revoke API key" จากเมนูแบบดรอปดาวน์
- ยืนยันการเพิกถอนคีย์ API โดยคลิกปุ่ม "Revoke API key" ในป๊อปอัป
ลบ Secret API Key#
คุณสามารถลบ Secret API Key ได้หลังจากที่ทำการเพิกถอนมันแล้วเท่านั้น ขั้นตอนการลบ Secret API Key:
- ไปที่หน้ารายละเอียดของ Secret API Key
- คลิกไอคอน ในหัวข้อของส่วนแรก
- เลือก "Delete" จากเมนูแบบดรอปดาวน์
- ยืนยันการลบคีย์ API โดยคลิกปุ่ม Delete ในป๊อปอัป