API_USER

API_USER คือบัญชีสำหรับการยืนยันเพื่อส่งข้อความใน EngageLab

คุณสามารถใช้ API เพื่อค้นหาหรือเพิ่ม API_USER

การค้นหา (การค้นหาแบบกลุ่ม)

ใช้ส่วนติดต่อผู้ใช้นี้เพื่อค้นหาข้อมูลพื้นฐานของ API_USER

URL

https://email.api.engagelab.cc/v1/api_users

              
              https://email.api.engagelab.cc/v1/api_users

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET

GET

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	String	true	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์การค้นหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
email_type	int	no	ประเภทอีเมลของ API_USER: 0(trigger), 1(batch)
api_user_type	int	no	ประเภทของ API_USER: 0(test), 1(normal)
domain_name	string	no	ชื่อโดเมนที่ผูกกับ API_USER

ตัวอย่างคำขอ

curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์	คำอธิบาย
api_user	ชื่อของ API_USER
api_user_type	ประเภทของ API_USER
email_type	ประเภทอีเมลของ API_USER
domain_name	ชื่อโดเมนที่ผูกกับ API_USER
click_tracking	การติดตามการคลิกเปิดใช้งานหรือไม่: false (ปิดใช้งาน), true (เปิดใช้งาน)
open_tracking	การติดตามการเปิดใช้งานหรือไม่: false (ปิดใช้งาน), true (เปิดใช้งาน)
unsubscribe_tracking	การติดตามการยกเลิกการสมัครเปิดใช้งานหรือไม่: false (ปิดใช้งาน), true (เปิดใช้งาน)

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": [ { "api_user": "xjmfcbatch", "api_user_type": 1, "email_type": 1, "domain_name": "sc.datavalidation.cn", "click_tracking": false, "open_tracking": false, "unsubscribe_tracking": false } ], "count": 85 }

              
              {
    "result": [
            {
                "api_user": "xjmfcbatch",
                "api_user_type": 1,
                "email_type": 1,
                "domain_name": "sc.datavalidation.cn",
                "click_tracking": false,
                "open_tracking": false,
                "unsubscribe_tracking": false
            }
         
        ],
        "count": 85
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }

              
              {
    "code": 30000,
    "message": "Authentication failed."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

เพิ่ม

API_USER และ API_KEY เป็นข้อมูลรับรองที่ใช้สำหรับการตรวจสอบสิทธิ์เมื่อผู้ใช้เรียกใช้อินเทอร์เฟซใน EngageLab โดยรองรับการแยกแยะระหว่างอีเมลที่ถูกกระตุ้นและประเภทอีเมลแบบกลุ่ม

อินเทอร์เฟซนี้ช่วยให้คุณสามารถเพิ่ม API_USER และส่งคืน API_KEY ที่สอดคล้องกัน

โปรดทราบว่าก่อนที่จะใช้อินเทอร์เฟซนี้เพื่อเพิ่ม API_USER ให้ยืนยันว่ามีการสร้าง API_USER และ API_KEY แล้วหรือยัง หากยังไม่ได้สร้าง คุณจำเป็นต้องเข้าสู่ระบบเว็บแบ็กเอนด์เพื่อสร้างเป็นครั้งแรก

URL

https://email.api.engagelab.cc/v1/api_users

              
              https://email.api.engagelab.cc/v1/api_users

โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-Type:

application/json; charset=utf-8

              
              application/json; charset=utf-8

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST

              
              POST

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	String	true	Basic base64(api_user:api_key)

คำอธิบายพารามิเตอร์ของเนื้อหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
api_user	string	ใช่	ชื่อของ API_USER ความยาว 1~64 ตัวอักษร สามารถประกอบด้วย A-Z, a-z, 0-9, _, @, -. เท่านั้น
email_type	int	ใช่	ประเภทอีเมลของ API_USER: 0 (triggered), 1 (batch)
domain_name	string	ใช่	ชื่อโดเมนที่ผูกกับ API_USER
track_domain_name	string	ไม่	ชื่อโดเมนติดตามที่ผูกกับ API_USER
click_tracking	boolean	ไม่	เปิดใช้งานการติดตามการอ่านหรือไม่: false (ปิดใช้งาน), true (เปิดใช้งาน). ค่าเริ่มต้น: false
open_tracking	boolean	ไม่	เปิดใช้งานการติดตามการคลิกหรือไม่: false (ปิดใช้งาน), true (เปิดใช้งาน). ค่าเริ่มต้น: false
unsubscribe_tracking	boolean	ไม่	เปิดใช้งานการติดตามการยกเลิกการสมัครหรือไม่: false (ปิดใช้งาน), true (เปิดใช้งาน). ค่าเริ่มต้น: true

คำอธิบาย:
การติดตามการยกเลิกการสมัคร ระบบจะบังคับใช้สำหรับผู้ใช้ฟรี

ตัวอย่างคำขอ

curl -X POST "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "api_user":"batch_edm", "email_type":1, "domain_name":"aizl.net" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/api_users" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "api_user":"batch_edm",
  "email_type":1,
  "domain_name":"aizl.net"
}'

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

Field	Description
api_user	ชื่อ API_USER
api_key	API_KEY
api_user_type	ประเภทของ API_USER
email_type	ประเภทอีเมลของ API_USER
domain_name	ชื่อโดเมนที่ผูกกับ API_USER
click_tracking	เปิดใช้งานการติดตามการคลิกหรือไม่
open_tracking	เปิดใช้งานการติดตามการเปิดหรือไม่
unsubscribe_tracking	เปิดใช้งานการติดตามการยกเลิกการสมัครหรือไม่

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": { "api_user": "xjmfcbatch", "api_user_type": 1, "api_key": "2*****", "email_type": 1, "domain_name": "sc.datavalidation.cn", "click_tracking": false, "open_tracking": false, "unsubscribe_tracking": true } }

              
              {
    "result": {
            "api_user": "xjmfcbatch",
            "api_user_type": 1,
            "api_key": "2*****",
            "email_type": 1,
            "domain_name": "sc.datavalidation.cn",
            "click_tracking": false,
            "open_tracking": false,
            "unsubscribe_tracking": true
    }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

{ "code": 31110, "message": "api_user cannot be empty." }

              
              {
    "code": 31110,
    "message": "api_user cannot be  empty."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย