API_USER

API_USER 是用戶在 EngageLab 中發信的驗證帳號。

你可以使用 API 進行 API_USER 的査詢，添加操作。

調用地址

數據中心	URL
新加坡	https://email.api.engagelab.cc
土耳其	https://emailapi-tr.engagelab.com

當使用REST API時，需要確認使用的數據中心選擇對應的base URL。

POST/v1/api_users

査詢（批量査詢）

通過此接口面査詢 API_USER 的基本資訊

URL

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

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

此代碼塊在浮窗中顯示

HTTP 請求方式

GET

GET

此代碼塊在浮窗中顯示

請求 Headers

Header	類型	必須	說明
Authorization	String	true	Basic base64(api_user:api_key)

Query 參數說明

參數	類型	必須	說明
email_type	int	否	API_USER 的郵件類型：0（觸發），1（批量）
api_user_type	int	否	API_USER 的類型：0（測試），1（普通）
domain_name	string	否	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": "Non-test", "email_type": "batch", "domain_name": "sc.datavalidation.cn", "click_tracking": false, "open_tracking": false, "unsubscribe_tracking": false } ], "count": 85 }

              
              {
    "result": [
            {
                "api_user": "xjmfcbatch",
                "api_user_type": "Non-test",
                "email_type": "batch",
                "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。如果尚未創建，首次獲取API_USER和API_KEY需要先登入網頁後臺進行創建。

URL

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

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

此代碼塊在浮窗中顯示

HTTP 請求方式

POST

              
              POST

此代碼塊在浮窗中顯示

請求 Headers

Header	類型	必須	說明
Authorization	String	true	Basic base64(api_user:api_key)

Body 參數說明

參數	類型	必須	說明
api_user	string	是	API_USER 的名稱。1~64 個字符，只能含有 A-Z,a-z,0-9,_,@,-。
email_type	int	是	API_USER 的郵件類型：0（觸發）, 1（批量）
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

說明

1. 取消訂閱追蹤 (unsubscirbe), 系統對於免費用戶會強制開啟。

              
              1. 取消訂閱追蹤 (unsubscirbe), 系統對於免費用戶會強制開啟。

此代碼塊在浮窗中顯示

請求示例

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"
}'

此代碼塊在浮窗中顯示

響應說明

字段	說明
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."
}

此代碼塊在浮窗中顯示