REST API
เรียนรู้วิธีผสานรวมและใช้งาน EngageLab SMS REST API
บริการ EngageLab SMS มีชุด RESTful API ที่ให้คุณสร้างเทมเพลตและลายเซ็น ส่ง SMS และตรวจสอบยอดคงเหลือได้ด้วยการเขียนโปรแกรม
โปรดทำตามขั้นตอนต่อไปนี้เพื่อเริ่มใช้งาน REST API
สร้าง API Key
ก่อนเรียกใช้ EngageLab SMS API ใด ๆ คุณต้องสร้าง API Key เพื่อยืนยันตัวตนสำหรับคำขอของคุณ
- เข้าสู่ระบบ คอนโซล EngageLab
- เข้าสู่คอนโซลย่อย SMS และเลือกแอปพลิเคชันของคุณ
- ไปที่ API Keys ในแถบนำทางด้านซ้าย
- คลิก Create API Key เพื่อสร้าง
dev_keyและdev_secretใหม่
⚠️ คำเตือน
dev_secretของคุณมีความอ่อนไหวสูง โปรดเก็บรักษาไว้อย่างปลอดภัย และอย่าเปิดเผยในโค้ดฝั่งไคลเอนต์หรือที่เก็บโค้ดสาธารณะโดยเด็ดขาด
การยืนยันตัวตน
EngageLab SMS API ใช้การยืนยันตัวตนแบบ HTTP Basic คุณต้องแนบส่วนหัว Authorization ในคำขอ API ทุกรายการ
ส่วนหัวนี้สร้างจากการเข้ารหัส Base64 โดยใช้ dev_key และ dev_secret ของคุณ:
Authorization: Basic ${base64_auth_string}
${base64_auth_string} ได้มาจากการนำ dev_key และ dev_secret ของคุณมาเชื่อมต่อกันด้วยเครื่องหมายทวิภาค (:) แล้วเข้ารหัสแบบ Base64: base64(dev_key:dev_secret)
สำหรับรายละเอียดเพิ่มเติม โปรดดูคู่มือ การยืนยันตัวตน
เรียกใช้ API
หลังจากได้รับ API Key และเข้าใจกลไกการยืนยันตัวตนแล้ว คุณก็สามารถเริ่มเรียกใช้ API ได้ จุดสิ้นสุด (endpoint) ของ API ทั้งหมดใช้ URL พื้นฐาน https://smsapi.engagelab.com
ต่อไปนี้คือ API หลักหลายรายการที่คุณสามารถผสานรวมได้:
- ส่งข้อความ SMS: ส่ง SMS ไปยังหมายเลขโทรศัพท์เป้าหมายหนึ่งหรือหลายหมายเลข รองรับการส่งการแจ้งเตือนและ SMS การตลาดแบบอัตโนมัติ
- ตรวจสอบยอดคงเหลือ: ตรวจสอบยอดคงเหลือที่ใช้ได้ของบัญชี EngageLab SMS แบบเรียลไทม์ผ่านอินเทอร์เฟซ API รวมถึงข้อมูลยอดคงเหลือทั่วไปและยอดคงเหลือแบบแถม
- การจัดการเทมเพลต: สร้าง แก้ไข ลบ ดึงรายการเทมเพลตทั้งหมด และดูรายละเอียดเทมเพลตด้วยการเขียนโปรแกรม
- การจัดการลายเซ็น: สร้าง แก้ไข ลบ ดึงรายการลายเซ็นทั้งหมด และดูรายละเอียดลายเซ็นด้วยการเขียนโปรแกรม
- ข้อมูลอ้างอิงเหตุการณ์ Callback: กำหนดค่า URL Callback และใช้กลไกการตรวจสอบความปลอดภัยเพื่อรับรายงานสถานะและการแจ้งเตือน
- SMPP: ใช้โปรโตคอล SMPP เพื่อให้การส่งข้อความและการรายงานสถานะเป็นไปอย่างมีประสิทธิภาพและน่าเชื่อถือผ่านการเชื่อมต่อ TCP
