จัดการ Publishable API Keys ใน ECM

ในคู่มือนี้ คุณจะได้เรียนรู้วิธีสร้างและจัดการ Publishable API Keys ใน ECM

Publishable API Key คืออะไร?#

Publishable API Key คือคีย์ฝั่งไคลเอนต์ (client key) ที่กำหนดขอบเขตการใช้งานไว้กับช่องทางการขาย (sales channels) ตั้งแต่หนึ่งช่องทางขึ้นไป เมื่อคุณสร้างหน้าร้าน (storefront) คุณต้องส่ง Publishable API Key ในส่วนหัวของคำขอ (request headers) เพื่อระบุช่องทางการขายที่จะกำหนดขอบเขตของคำขอนั้น การดำเนินการนี้ส่งผลต่อสินค้าที่ดึงออกมา จำนวนสต็อกสินค้าที่พร้อมจำหน่าย และข้อมูลอื่น ๆ

หากต้องการเรียนรู้วิธีการส่ง Publishable API Key ในส่วนหัวของคำขอ โปรดดูที่ API Reference

ดู Publishable API Keys#

หากต้องการดู Publishable API Keys ใน ECM ให้ไปที่ Settings -> Publishable API Keys

ที่นี่ คุณสามารถดูรายการของ Publishable API Keys ทั้งหมดที่คุณตั้งค่าไว้ในร้านค้าของคุณ นอกจากนี้ยังสามารถค้นหา กรอง และจัดเรียงคีย์ API เพื่อค้นหาคีย์ที่คุณต้องการได้

สร้าง Publishable API Key#

ขั้นตอนการสร้าง Publishable API Key ใหม่:

1. ไปที่ Settings -> Publishable API Keys
2. คลิกปุ่ม Create ในหัวข้อของส่วนหลัก
3. ในฟอร์มที่เปิดขึ้น ให้กรอกชื่อ (title) ของ Publishable API Key
4. เมื่อเสร็จแล้ว ให้คลิกปุ่ม Save

ดูรายละเอียดของ Publishable API Key#

ขั้นตอนการดูรายละเอียดของ Publishable API Key:

1. ไปที่ Settings -> Publishable API Keys
2. คลิกที่ Publishable API Key ที่ต้องการในรายการ

หน้าจอนี้จะเปิดหน้ารายละเอียดของ Publishable API Key ซึ่งคุณสามารถจัดการคีย์ API ดังกล่าวได้ด้วย

สถานะของ Publishable API Key#

คุณสามารถดูสถานะของ Publishable API Key ได้ในหัวข้อของส่วนแรกในหน้ารายละเอียด สถานะของ Publishable API Key สามารถเป็น:

คัดลอก Publishable API Key#

ขั้นตอนการคัดลอก Publishable API Key:

1. ไปที่หน้ารายละเอียดของ Publishable API Key
2. ในส่วนแรก ให้คลิกที่คีย์ส่วนที่ถูกย่อไว้เพื่อคัดลอกไปยังคลิปบอร์ดของคุณ

แก้ไข Publishable API Key#

ขั้นตอนการแก้ไข Publishable API Key:

1. ไปที่หน้ารายละเอียดของ Publishable API Key
2. คลิกไอคอน ในหัวข้อของส่วนแรก
3. เลือก "Edit" จากเมนูแบบดรอปดาวน์
4. ในหน้าต่างด้านข้างที่เปิดขึ้น คุณสามารถแก้ไขชื่อ (title) ของ Publishable API Key ได้
5. เมื่อเสร็จแล้ว ให้คลิกปุ่ม Save

จัดการช่องทางการขายของ Publishable API Key#

คุณสามารถจัดการช่องทางการขาย (sales channels) ของ Publishable API Key ได้จากหน้ารายละเอียด การเพิ่มช่องทางการขายให้กับ Publishable API Key จะช่วยกำหนดขอบเขตของคำขอที่ส่งด้วยคีย์นี้

เพิ่มช่องทางการขาย#

ขั้นตอนการเพิ่มช่องทางการขายให้กับ Publishable API Key:

1. ไปที่หน้ารายละเอียดของ Publishable API Key
2. คลิกปุ่ม "Add" ในหัวข้อของส่วน "Sales Channels"
3. ในรายการที่เปิดขึ้น ให้ทำเครื่องหมายเลือกช่องทางการขายที่คุณต้องการเพิ่มคีย์ API นี้เข้าไป
4. เมื่อเสร็จแล้ว ให้คลิกปุ่ม Save

ลบช่องทางการขาย#

ขั้นตอนการลบช่องทางการขายออกจาก Publishable API Key:

1. ไปที่หน้ารายละเอียด of Publishable API Key
2. ทำเครื่องหมายในช่องสี่เหลี่ยมถัดจากช่องทางการขายที่คุณต้องการลบออกในส่วน "Sales Channels"
3. กดปุ่ม R หรือคลิกปุ่ม Remove ที่กึ่งกลางด้านล่างของหน้าจอ
4. ยืนยันการลบช่องทางการขายโดยคลิกปุ่ม Continue

เพิกถอน Publishable API Key#

ขั้นตอนการเพิกถอน Publishable API Key:

1. ไปที่หน้ารายละเอียดของ Publishable API Key
2. คลิกไอคอน ในหัวข้อของส่วนแรก
3. เลือก "Revoke API key" จากเมนูแบบดรอปดาวน์
4. ยืนยันการเพิกถอนคีย์ API โดยคลิกปุ่ม "Revoke API key" ในป๊อปอัป

ลบ Publishable API Key#

คุณสามารถลบ Publishable API Key ได้หลังจากที่ทำการเพิกถอนมันแล้วเท่านั้น ขั้นตอนการลบ Publishable API Key:

1. ไปที่หน้ารายละเอียดของ Publishable API Key
2. คลิกไอคอน ในหัวข้อของส่วนแรก
3. เลือก "Delete" จากเมนูแบบดรอปดาวน์
4. ยืนยันการลบคีย์ API โดยคลิกปุ่ม Delete ในป๊อปอัป