REST API
เรียนรู้วิธีผสานและใช้งาน EngageLab OTP REST API
บริการ EngageLab OTP มีชุด RESTful API ที่ช่วยให้คุณสามารถสร้างเทมเพลต ส่ง OTP และตรวจสอบรหัส OTP ผ่านการเขียนโปรแกรมได้
โปรดทำตามขั้นตอนต่อไปนี้เพื่อเริ่มต้นใช้งาน REST API
สร้าง API Key
ก่อนเรียกใช้ EngageLab OTP API ใด ๆ คุณจำเป็นต้องสร้าง API Key เพื่อยืนยันตัวตนของคำขอของคุณ
- เข้าสู่ระบบ คอนโซล EngageLab
- เข้าสู่คอนโซลย่อย OTP แล้วเลือกแอปพลิเคชันของคุณ
- ไปที่ API Keys ในแถบนำทางด้านซ้าย
- คลิก Create API Key เพื่อสร้าง
dev_keyและdev_secretใหม่
⚠️ คำเตือน
dev_secretของคุณมีความละเอียดอ่อนสูง โปรดเก็บรักษาไว้อย่างปลอดภัย และอย่าเปิดเผยในโค้ดฝั่งไคลเอนต์หรือในคลังโค้ดสาธารณะโดยเด็ดขาด
การยืนยันตัวตน
EngageLab OTP 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 ได้ จุดสิ้นสุด API (endpoint) ทั้งหมดใช้ URL พื้นฐาน https://otp.api.engagelab.cc
ต่อไปนี้คือ API หลักหลายตัวที่คุณสามารถผสานเข้าด้วยกันได้:
- การส่งรหัส OTP: สร้างรหัส OTP ผ่านแพลตฟอร์ม EngageLab และส่งตามกลยุทธ์เทมเพลตของคุณ
- การตรวจสอบรหัส OTP: ตรวจสอบรหัสผ่านแบบใช้ครั้งเดียว (รหัส OTP) ที่ผู้ใช้ส่งมาอย่างปลอดภัย
- การส่งรหัส OTP ที่กำหนดเอง: หากคุณต้องการสร้างรหัส OTP เอง คุณสามารถส่งรหัส OTP ที่สร้างไว้ล่วงหน้าให้กับผู้ใช้ได้
- การส่งข้อความที่กำหนดเอง: ส่งเนื้อหาข้อความที่สร้างขึ้นจากเทมเพลตที่กำหนดเอง (เช่น การแจ้งเตือนหรือข้อความการตลาด)
- การจัดการเทมเพลต: สร้าง ลบ ดึงรายการเทมเพลตทั้งหมด และดูรายละเอียดเทมเพลตผ่านการเขียนโปรแกรม
- การตั้งค่าการเรียกกลับ: ตั้งค่าที่อยู่การเรียกกลับและรับรายงานสถานะและการแจ้งเตือนโดยใช้กลไกการตรวจสอบความปลอดภัย
- การเรียกกลับสถานะวงจรชีวิต: รับข้อมูลสถานะวงจรชีวิตต่าง ๆ ของข้อความ เช่น การส่ง การส่งถึง และการตรวจสอบ แบบเรียลไทม์ผ่านการเรียกกลับ
- SMPP: ใช้โปรโตคอล SMPP เพื่อส่งข้อความและรายงานสถานะอย่างมีประสิทธิภาพและเชื่อถือได้ผ่านการเชื่อมต่อ TCP
