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が既に作成されているかどうかを確認してください。まだ作成されていない場合は、最初にWebバックエンドにログインして作成する必要があります。
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（トリガー）、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 |
説明:
トラッキングの解除、システムは無料ユーザーに対してこれを強制します。
リクエスト例
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."
}
このコードブロックはフローティングウィンドウ内に表示されます
