การติดตามโดเมน
จัดการโดเมนการติดตามของคุณ
การค้นหา
รับรายการโดเมนการติดตาม
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
คำอธิบายพารามิเตอร์การค้นหา
| Parameter | Type | Required or not | Description |
|---|---|---|---|
| name | string | no | โดเมน |
| offset | int | no | ตำแหน่งเริ่มต้น [0-] ค่าเริ่มต้นคือ 0 |
| limit | int | no | จำนวน [0-100] ค่าเริ่มต้นคือ 100 |
ตัวอย่างคำขอ
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายค่าที่ส่งกลับ
| Parameter | Description |
|---|---|
| domain_id | รหัสโดเมน |
| name | โดเมน |
| cname | รายละเอียดของบันทึก CNAME ของโดเมน |
| verify | การตั้งค่าสำเร็จหรือไม่ (true หรือ false) |
| verify_message | ข้อความอธิบายบันทึก CNAME หากบันทึกถูกต้องจะเป็น null |
| required_record | บันทึก CNAME ที่ต้องตั้งค่า |
| existed_record | บันทึก CNAME ที่ผู้ใช้ตั้งค่าไว้ |
| cert | รายละเอียดใบรับรองของโดเมน |
| verify | การตั้งค่าสำเร็จหรือไม่ (true หรือ false) |
| verify_message | ใบรับรองไม่ได้อัปโหลด, ใบรับรองกำลังตั้งค่า, ใบรับรองมีผล, ใบรับรองหมดอายุ |
| expired_date | วันที่หมดอายุ |
| create_time | เวลาที่สร้างโดเมน |
| update_time | เวลาที่แก้ไขโดเมน |
ตัวอย่างค่าที่ส่งกลับ
Response-success
HTTP Status: 200
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "the certificate has not been uploaded",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "the certificate has not been uploaded",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การเพิ่ม
เพิ่มโดเมนการติดตามไปยังบัญชีของคุณ
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
คำอธิบายพารามิเตอร์ Body
| Parameter | Type | Required or not | Description |
|---|---|---|---|
| name | string | yes | โดเมน |
คำแนะนำ:
คุณสามารถเพิ่มโดเมนการติดตามที่กำหนดเองได้สูงสุด 5 โดเมน เมื่อการตรวจสอบการตั้งค่าสำเร็จ โดเมนจะไม่สามารถแก้ไขได้ การตั้งค่าที่ผิดพลาดอาจทำให้ลิงก์ในอีเมลไม่สามารถคลิกได้ ข้อมูลการติดตามไม่ถูกต้อง ฯลฯ
เนื่องจากการอัปเกรดของ Chrome และเบราว์เซอร์อื่นๆ ในอนาคตจะห้ามการโหลดทรัพยากร HTTP ซึ่งอาจทำให้เนื้อหาถูกบล็อกโดยผิดพลาดและเกิดปัญหาข้อมูลการติดตาม ขอแนะนำให้อัปโหลดใบรับรอง SSL เพื่อทำการตั้งค่า HTTPS และเปิดใช้งานการติดตาม HTTPS
ตัวอย่างคำขอ
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"track.leonww.asia"
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"track.leonww.asia"
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายค่าที่ส่งกลับ
| Parameter | Description |
|---|---|
| domain_id | รหัสโดเมน |
| name | โดเมน |
| cname | รายละเอียดของบันทึก CNAME ของโดเมน |
| verify | การตั้งค่าสำเร็จหรือไม่ (true หรือ false) |
| verify_message | ข้อความอธิบายบันทึก CNAME หากบันทึกถูกต้องจะเป็น null |
| required_record | บันทึก CNAME ที่ต้องตั้งค่า |
| existed_record | บันทึก CNAME ที่มีอยู่ |
| create_time | เวลาที่สร้างโดเมน |
| update_time | เวลาที่แก้ไขโดเมน |
ตัวอย่างค่าที่ส่งกลับ
Response-success
HTTP Status: 200
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "The cname record is not configured",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :400
{
"code": 31003,
"message": "Domain name format error"
}
{
"code": 31003,
"message": "Domain name format error"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การแก้ไข
แก้ไขโดเมนการติดตามผ่านอินเทอร์เฟซนี้
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
PUT
PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | Basic base64(apiUser:apiKey) |
คำอธิบายพารามิเตอร์ Body
| Parameter | Type | Required or not | Description |
|---|---|---|---|
| name | string | yes | โดเมน ต้องเป็นไปตามรูปแบบโดเมน สามารถมีได้เฉพาะตัวอักษร ตัวเลข ขีดกลาง (-) และจุด (.) ความยาวต้องอยู่ระหว่าง 4 ถึง 255 ตัวอักษร (เช่น mail.test.best) |
ตัวอย่างคำขอ
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างค่าที่ส่งกลับ
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :400
{
"code": 31003,
"message": "Domain name format error"
}
{
"code": 31003,
"message": "Domain name format error"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การตรวจสอบ
ตรวจสอบโดเมนการติดตามผ่านอินเทอร์เฟซนี้
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
หมายเหตุ
ส่งคืนโดเมนที่ตรวจสอบแล้ว
ส่งคืนโดเมนที่ตรวจสอบแล้ว
โค้ดนี้โชว์เป็นหน้าต่างลอย
ตัวอย่างคำขอ
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายค่าที่ส่งกลับ
| Parameter | Description |
|---|---|
| domain_id | รหัสโดเมน |
| name | โดเมน |
| cname | รายละเอียดของบันทึก CNAME ของโดเมน |
| verify | การตั้งค่าสำเร็จหรือไม่ (true หรือ false) |
| verify_message | ข้อความอธิบายบันทึก CNAME หากบันทึกถูกต้องจะเป็น null |
| required_record | บันทึก CNAME ที่ต้องตั้งค่า |
| existed_record | บันทึก CNAME ที่มีอยู่ |
| cert | รายละเอียดใบรับรองของโดเมน |
| verify | การตั้งค่าสำเร็จหรือไม่ (true หรือ false) |
| verify_message | ใบรับรองไม่ได้อัปโหลด, ใบรับรองกำลังตั้งค่า, ใบรับรองมีผล, ใบรับรองหมดอายุ |
| expired_date | วันที่หมดอายุ |
| create_time | เวลาที่สร้างโดเมน |
| update_time | เวลาที่แก้ไขโดเมน |
ตัวอย่างค่าที่ส่งกลับ
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "The configuration is successful",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "the certificate has taken effect",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การเพิ่มใบรับรอง
เพิ่มใบรับรองสำหรับโดเมนการติดตาม
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายพารามิเตอร์ Body
| parameter | type | required or not | description |
|---|---|---|---|
| cert_content | string | yes | เนื้อหาใบรับรอง ค่าเป็นรูปแบบ PEM encoding |
| cert_key | string | yes | คีย์ส่วนตัวของใบรับรอง ค่าเป็นรูปแบบ PEM encoding |
ตัวอย่างคำขอ
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--data '{
"cert_content":"...",
"cert_key":"...",
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--data '{
"cert_content":"...",
"cert_key":"...",
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายค่าที่ส่งกลับ
| Parameter | Description |
|---|---|
| domain_id | รหัสโดเมน |
| name | โดเมน |
| cert | รายละเอียดใบรับรองของโดเมน |
| verify | การตั้งค่าสำเร็จหรือไม่ (true หรือ false) |
| verify_message | ใบรับรองไม่ได้อัปโหลด, ใบรับรองกำลังตั้งค่า, ใบรับรองมีผล, ใบรับรองหมดอายุ |
| expired_date | วันที่หมดอายุ |
| create_time | เวลาที่สร้างโดเมน |
| update_time | เวลาที่แก้ไขโดเมน |
ตัวอย่างค่าที่ส่งกลับ
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "the certificate is being configured",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "the certificate is being configured",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การอัปเดตใบรับรอง
อัปเดตใบรับรองสำหรับโดเมนการติดตาม
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
PUT
PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายพารามิเตอร์ Body
| parameter | type | required or not | description |
|---|---|---|---|
| cert_content | string | yes | เนื้อหาใบรับรอง ค่าเป็นรูปแบบ PEM encoding |
| cert_key | string | yes | คีย์ส่วนตัวของใบรับรอง ค่าเป็นรูปแบบ PEM encoding |
ตัวอย่างคำขอ
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การอัปเดต API_USER
อัปเดตโดเมนการติดตามและการตั้งค่าการติดตามที่เกี่ยวข้องกับ API_USER
URL
https://email.api.engagelab.cc/v1/api_users/{api_user}
https://email.api.engagelab.cc/v1/api_users/{api_user}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
PUT
PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายพารามิเตอร์เนื้อหา
| พารามิเตอร์ | ประเภท | จำเป็นหรือไม่ | คำอธิบาย |
|---|---|---|---|
| domain_name | string | ไม่ | โดเมนที่ผูกกับ API_USER |
| track_domain_name | string | ไม่ | โดเมนติดตามที่ผูกกับ API_USER |
| open_tracking | boolean | ไม่ | เปิดใช้งานการติดตามการเปิดหรือไม่ ค่า: false (ปิดใช้งาน), true (เปิดใช้งาน) ค่าเริ่มต้นคือ false |
| click_tracking | boolean | ไม่ | เปิดใช้งานการติดตามการคลิกหรือไม่ ค่า: false (ปิดใช้งาน), true (เปิดใช้งาน) ค่าเริ่มต้นคือ false |
| unsubscribe_tracking | boolean | ไม่ | เปิดใช้งานการติดตามการยกเลิกการสมัครหรือไม่ ค่า: false (ปิดใช้งาน), true (เปิดใช้งาน) ค่าเริ่มต้นคือ true |
ตัวอย่างคำขอ
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
