คีย์ API

ด้วยการใช้ API การส่ง SMS ที่จัดเตรียมโดย EngageLab คุณสามารถทำการส่ง SMS โดยอัตโนมัติโดยไม่ต้องดำเนินการด้วยตนเองบนแพลตฟอร์ม หน้าการจัดการคีย์ API รองรับการสร้าง การดู และการลบคีย์อย่างรวมศูนย์ ช่วยให้นักพัฒนาสามารถผสานรวมและจัดการบริการ SMS ได้อย่างมีประสิทธิภาพและปลอดภัย

คำเตือนด้านความปลอดภัย:
คีย์ API ให้สิทธิ์การเข้าถึง API บริการ SMS โปรดเก็บรักษาคีย์ให้ปลอดภัยและอย่าแชร์กับบุคคลที่สาม

การสร้างคีย์ API

ก่อนที่จะใช้ EngageLab SMS API เพื่อส่งข้อความ คุณจำเป็นต้องสร้างคีย์การตรวจสอบสิทธิ์ API Basic
alt text คลิกปุ่ม "Create API Key" ที่มุมขวาบนของหน้าเพื่อเข้าสู่หน้าการสร้างคีย์ กรอกข้อมูลต่อไปนี้ทีละขั้นตอน:

คำอธิบายคีย์ API
ระบุคำอธิบายที่กำหนดเองสำหรับวัตถุประสงค์ของคีย์เพื่อให้ง่ายต่อการระบุและจัดการในอนาคต ใช้เพื่อการอ้างอิงเท่านั้น
วันที่หมดอายุ (ไม่บังคับ)
กำหนดวันที่หมดอายุสำหรับคีย์ คีย์จะหมดอายุโดยอัตโนมัติหลังจากวันที่นี้ หากเว้นว่างไว้ คีย์จะยังคงใช้งานได้ไม่มีกำหนด
รายการ IP ที่อนุญาต (ไม่บังคับ)
จำกัดที่อยู่ IP ที่สามารถใช้คีย์นี้ได้ แนะนำให้กำหนดค่านี้ในสภาพแวดล้อมการผลิตเพื่อเพิ่มความปลอดภัย IP หลายรายการควรคั่นด้วยเครื่องหมายจุลภาค (,) หากเว้นว่างไว้ จะไม่มีการจำกัด IP

หลังจากกรอกแบบฟอร์มเสร็จแล้ว คลิกปุ่ม "Confirm" ระบบจะสร้าง DevKey และ DevSecret โดยอัตโนมัติ ซึ่งจะแสดงในรายการคีย์

alt text

รายการคีย์ API

ส่วนการกรอง

การค้นหาแบบคลุมเครือ
- ค้นหาอย่างรวดเร็วโดยใช้คำอธิบายคีย์หรือคำสำคัญ DevKey
ตัวกรองส่วนหัว
- กรองตามสถานะคีย์โดยใช้ตัวเลือกแบบเลื่อนลง
ตัวกรองเวลา
- กรองตามวันที่หมดอายุของคีย์
ตัวกรองแบบรวม
- ใช้เงื่อนไขหลายอย่างเพื่อกรองผลลัพธ์แบบเรียลไทม์

คำอธิบายฟิลด์

ฟิลด์	คำอธิบาย
Description	คำอธิบายที่ผู้ใช้กำหนดสำหรับวัตถุประสงค์ของคีย์เพื่อการจัดการที่ง่ายขึ้น
DevKey	ตัวระบุเฉพาะของคีย์ ใช้สำหรับการตรวจสอบสิทธิ์ API
DevSecret	คีย์ลับ ซึ่งซ่อนโดยค่าเริ่มต้น วางเมาส์เพื่อแสดงหรือคัดลอกข้อความธรรมดา
Creation Date	วันที่ที่สร้างคีย์
Expiration Date	วันที่หมดอายุของคีย์ ซึ่งสามารถแก้ไขได้
Status	สถานะปัจจุบันของคีย์ รวมถึง "Enabled" และ "Disabled" วางเมาส์เพื่อแสดงปุ่มสลับสำหรับเปลี่ยนสถานะ
Actions	รวมถึงปุ่ม "Edit" และ "Delete" การลบต้องการการยืนยัน

การแสดง/ซ่อน DevSecret
- คีย์ลับจะถูกซ่อนโดยค่าเริ่มต้นด้วยเครื่องหมายดอกจัน วางเมาส์เพื่อแสดงข้อความธรรมดาหรือคัดลอกเนื้อหา เพื่อเพิ่มความปลอดภัย
การสลับสถานะ
- สถานะถูกควบคุมโดยปุ่มสลับ วางเมาส์เพื่อแสดง "On/Off" และคลิกเพื่อเปลี่ยนระหว่างเปิดใช้งานและปิดใช้งาน การปิดใช้งานต้องการการยืนยันเพื่อป้องกันการดำเนินการโดยไม่ตั้งใจ
  
  หมายเหตุ: หลังจากสลับสถานะคีย์แล้ว โปรดตรวจสอบให้แน่ใจว่าระบบธุรกิจทั้งหมดได้รับการอัปเดตเพื่อหลีกเลี่ยงข้อผิดพลาดที่เกิดจากความไม่สอดคล้องของสถานะ

การดูรายละเอียดคีย์

คลิกที่แถวใดก็ได้ในรายการคีย์เพื่อเข้าสู่หน้ารายละเอียดคีย์ ซึ่งคุณสามารถดูข้อมูลการกำหนดค่าที่สมบูรณ์และบันทึกการดำเนินการได้
alt text

การแก้ไขคีย์ API

คลิกปุ่ม "Edit" เพื่อเข้าสู่หน้าการแก้ไขคีย์ ซึ่งคุณสามารถแก้ไขคำอธิบายคีย์ วันที่หมดอายุ รายการ IP ที่อนุญาต และรีเซ็ต DevSecret ได้
alt text

รีเซ็ต DevSecret
- ในป๊อปอัปการแก้ไข คลิก "Reset" เพื่อเรียกใช้กล่องยืนยัน เมื่อยืนยันแล้ว ระบบจะสร้าง DevSecret ใหม่โดยอัตโนมัติ
  
  หลังจากรีเซ็ตแล้ว DevSecret เดิมจะไม่สามารถใช้งานได้ทันที โปรดอัปเดตระบบธุรกิจทั้งหมดด้วยคีย์ใหม่โดยทันที

การลบคีย์

ในการลบคีย์ คลิกปุ่ม "Delete" และยืนยันการดำเนินการเพื่อทำการลบให้เสร็จสมบูรณ์
alt text

หลังจากลบแล้ว คีย์จะไม่สามารถใช้งานได้สำหรับการเรียก API ใด ๆ โปรดตรวจสอบให้แน่ใจว่าระบบธุรกิจทั้งหมดได้เปลี่ยนและสำรองข้อมูลคีย์ก่อนการลบ