Rest API 概要
ข้อจำกัดพื้นฐาน
- การออกแบบ API ปฏิบัติตามข้อกำหนดของ HTTP และ REST ตัวอย่างเช่น ใช้วิธี GET สำหรับการร้องขอแบบ Query และใช้วิธี POST สำหรับการร้องขอแบบ Submit หากการร้องขอไม่ได้ใช้วิธี HTTP ที่เหมาะสม จะส่งคืนข้อผิดพลาด
- เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าพารามิเตอร์ที่เรียกใช้ควรถูกเข้ารหัสเป็น UTF-8 และทำ URL Encoding
ศูนย์ข้อมูลและ URL พื้นฐาน
ศูนย์ข้อมูล | URL พื้นฐาน |
---|---|
สิงคโปร์ | https://ma-api.engagelab.com |
เมื่อใช้ REST API คุณจำเป็นต้องรวม URL พื้นฐานที่เลือกไว้กับเส้นทาง API เฉพาะเพื่อให้ได้ที่อยู่การเรียกใช้งานที่สมบูรณ์
{URL พื้นฐาน}/{เส้นทาง API}
{URL พื้นฐาน}/{เส้นทาง API}
このコードブロックはフローティングウィンドウ内に表示されます
วิธีการรับรองความถูกต้อง
EngageLab REST API ใช้วิธีการรับรองความถูกต้องแบบ HTTP Basic Authentication: โดยเพิ่ม Authorization ใน HTTP Header:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
このコードブロックはフローティングウィンドウ内に表示されます
อัลกอริทึมการสร้าง base64_auth_string ดังนี้: base64(api_key:api_secret)
- ชื่อ Header คือ "Authorization" และค่าคือคู่ "username:password" ที่ถูกแปลงเป็น base64 (คั่นกลางด้วยเครื่องหมายโคลอน)
- ในกรณีของ MA API, username คือ APIKey และ password คือ APISecret โปรดเพิ่มแหล่งข้อมูลประเภท API ในแหล่งข้อมูลเพื่อรับ APIKey และ APISecret