ภาพรวม REST API
ข้อกำหนดพื้นฐาน
- API นี้ได้รับการออกแบบให้สอดคล้องกับข้อกำหนดของ HTTP และ REST ตัวอย่างเช่น คำขอสำหรับดึงข้อมูลจะใช้เมธอด
GETขณะที่คำขอสำหรับส่งข้อมูลจะใช้เมธอดPOSTหากคำขอไม่ได้ใช้เมธอด HTTP ที่สอดคล้องกัน ระบบจะแสดงข้อผิดพลาด - เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าพารามิเตอร์ในคำขอต้องเข้ารหัสเป็น UTF-8 โดยใช้ URL encoding
ดาต้าเซ็นเตอร์และ Base URL
| Data Center | Base URL |
|---|---|
| Singapore | https://livedesk-api.engagelab.com |
เมื่อใช้งาน LiveDesk REST API ให้นำ Base URL ที่เลือกมารวมกับพาธของ API ที่ต้องการ เพื่อสร้าง URL คำขอแบบสมบูรณ์
{base URL}/{API path}
{base URL}/{API path}
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการยืนยันตัวตน
EngageLab REST API ใช้ HTTP Basic Authentication โดยให้เพิ่ม Authorization ในส่วนหัว HTTP:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
โค้ดนี้โชว์เป็นหน้าต่างลอย
อัลกอริทึมสำหรับสร้าง base64_auth_string คือ:
base64(api_key:api_secret)
base64(api_key:api_secret)
โค้ดนี้โชว์เป็นหน้าต่างลอย
- ชื่อส่วนหัวคือ
Authorizationและค่าของส่วนหัวคือคู่username:passwordที่เข้ารหัสด้วย Base64 โดยคั่นด้วยเครื่องหมายโคลอน - ในบริบทของ LiveDesk API นั้น username คือ API Key และ password คือ API Secret ให้เพิ่มแหล่งข้อมูลประเภท API ภายใต้ Project Settings > API Management เพื่อรับ API Key และ API Secret
