รับ EUID
EUID คือ EngageLab MA Platform User ID ที่ไม่ซ้ำกัน คุณสามารถใช้ API ด้านล่างเพื่อรับ EUID ตามตัวระบุผู้ใช้
ที่อยู่สำหรับเรียกใช้งาน
POST /v1/user/register
การตรวจสอบการเรียกใช้งาน
EngageLab REST API ใช้วิธีการตรวจสอบ HTTP Basic Authentication: เพิ่ม Authorization ลงใน HTTP Header:
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
ตัวอย่างคำขอ
Header คำขอ
> POST /v1/user/register
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
เนื้อหาคำขอ
{
"identity_name":"user_id", // ชื่อตัวระบุผู้ใช้
"identity_values": [
"18012345678", // ค่าตัวระบุผู้ใช้
"18012345678"
]
}
พารามิเตอร์คำขอ
ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
identity_name | String | ใช่ | ชื่อตัวระบุผู้ใช้ รองรับการส่งค่า user_id, anonymous_id, registration_id เป็นต้น |
identity_values | list | ใช่ | ค่าตัวระบุผู้ใช้ รองรับสูงสุด 100 ค่า แต่ละค่าห้ามเกิน 256 ตัวอักษร |
พารามิเตอร์การตอบกลับ
ฟิลด์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
code | Int | ใช่ | แสดงผลว่าการเรียกใช้งานสำเร็จหรือไม่ 0 หมายถึงสำเร็จหรือสำเร็จบางส่วน ค่าอื่นหมายถึงล้มเหลว |
message | String | ใช่ | คำอธิบายผลลัพธ์ของการเรียกใช้งาน |
data | Array | ไม่ | รายการ EUID ที่สอดคล้องกับตัวระบุผู้ใช้ที่ส่งมา |
identity_value | String | ใช่ | ค่าตัวระบุผู้ใช้ |
euid | Long | ใช่ | EngageLab MA User ID ที่ไม่ซ้ำกัน |
error_code | Int | ใช่ | แสดงผลว่าการรับ EUID สำเร็จหรือไม่ 0 หมายถึงสำเร็จ ค่าอื่นหมายถึงล้มเหลว |
สำเร็จทั้งหมด
{
"code": 0,
"message": "success",
"data": [
{
"identity_value": "18012345678", // ค่าตัวระบุผู้ใช้
"euid": 10362473, // EUID ที่สร้างขึ้น หากล้มเหลวจะเป็น null
"error_code": 0 // รหัสข้อผิดพลาดที่สอดคล้อง 0 หมายถึงสำเร็จ ไม่ว่างหมายถึงล้มเหลว เช่น 40006
},
{
"identity_value": "18012340000",
"euid": 10362474,
"error_code": 0
}
]
}
ล้มเหลวทั้งหมด
{
"code": 55101,
"message": "เกินจำนวนตัวระบุผู้ใช้ที่กำหนด"
}
สำเร็จบางส่วน
{
"code": 0,
"message": "success",
"data": [
{
"identity_value": "18012345678", // ค่าตัวระบุผู้ใช้
"euid": null, // หากล้มเหลวจะเป็น null
"error_code": -1 // รหัสข้อผิดพลาดที่สอดคล้อง 0 หมายถึงสำเร็จ ไม่ว่างหมายถึงล้มเหลว
},
{
"identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
"euid": null,
"error_code": 55105
}
]
}
รหัสข้อผิดพลาด
|รหัส| คำอธิบาย| รายละเอียดเพิ่มเติม | | ----- | -------- | ----------------------- | -------------------------- | | 40050 | การตรวจสอบ API ล้มเหลว | โปรดยืนยันว่า Project ID และ Project Secret ถูกต้อง | | 40007 | EUID ว่างเปล่า | โปรดตรวจสอบค่าของ EUID | | 50031 | Project ID ไม่ถูกต้อง | โปรดตรวจสอบว่า APIKey และ APISecret ถูกต้อง | | 50034 | Project ID ไม่มีอยู่ | โปรดตรวจสอบว่า APIKey และ APISecret ถูกต้อง และตรวจสอบว่าโปรเจกต์ถูกลบหรือไม่ | | 50074 | แหล่งข้อมูล API ไม่มีอยู่ | โปรดตรวจสอบว่า APIKey และ APISecret ถูกต้อง และตรวจสอบว่าแหล่งข้อมูล API ถูกลบหรือไม่ | | 55004 | พารามิเตอร์ธุรกิจไม่ถูกต้อง | โปรดตรวจสอบว่าฟิลด์พารามิเตอร์คำขอถูกต้องหรือไม่ | | 55101 | เกินจำนวนตัวระบุผู้ใช้ที่กำหนด | โปรดยืนยันว่าจำนวนค่าตัวระบุผู้ใช้ไม่เกิน 100 | | 55102 | มีชื่อคุณสมบัติผู้ใช้ที่ไม่ถูกต้อง | โปรดยืนยันว่าชื่อคุณสมบัติตรงตามข้อกำหนดการตั้งชื่อหรือไม่ และไม่ว่างเปล่า/ใช้ตัวอักษรที่สงวนไว้/เกินขีดจำกัดความยาว | | 55103 | ค่าคุณสมบัติผู้ใช้ไม่สามารถว่างเปล่าได้ | โปรดยืนยันว่าค่าคุณสมบัติผู้ใช้ในเนื้อหาคำขอไม่ว่างเปล่า | | 55105 | ค่าตัวระบุผู้ใช้ไม่สามารถเกิน 256 ตัวอักษร | โปรดยืนยันว่าค่าตัวระบุผู้ใช้ไม่เกิน 256 ตัวอักษร | | 55106 | ชื่อตัวระบุผู้ใช้ไม่อยู่ในขอบเขตที่รองรับ | โปรดยืนยันว่าชื่อตัวระบุผู้ใช้คือ user_id, anonymous_id หรือ registration_id | | 55107 | ค่าตัวระบุผู้ใช้ว่างเปล่า | โปรดยืนยันว่าค่าตัวระบุผู้ใช้ในเนื้อหาคำขอไม่ว่างเปล่า | | 55108 | EUID ไม่ถูกต้อง | โปรดตรวจสอบค่าของ EUID | | -1 | ข้อผิดพลาดภายในเซิร์ฟเวอร์ | โปรดติดต่อฝ่ายสนับสนุนทางเทคนิคของ EngageLab |