ドメイン名
ユーザーは、メールを正常に送信するために送信ドメイン名を設定する必要があります。
APIを使用して、ドメイン名のクエリ、追加、変更を行うことができます。
クエリ（バッチクエリ）
このインターフェースを使用して、ドメイン名の基本情報をクエリします。
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/domains
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
クエリパラメータ説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | No | ドメイン名。複数の名前は ; で区切ります。 |
| type | int | No | ドメインタイプ: 0（テストドメイン）、1（通常ドメイン）。 |
リクエスト例
curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| フィールド | 説明 |
|---|---|
| domain_id | ドメインID |
| name | ドメイン名 |
| type | ドメインタイプ |
| spf | SPFレコード |
| domain | SPFホストレコード |
| value | このドメインのSPF設定値 |
| verify | 設定成功（trueまたはfalse） |
| dkim | DKIMレコード |
| domain | このドメインのDKIMホストレコード |
| value | このドメインのDKIM設定値 |
| verify | 設定成功（trueまたはfalse） |
| mx | MXレコード |
| domain | MXホストレコード |
| value | このドメインのMX設定値 |
| verify | 設定成功（trueまたはfalse） |
| dmarc | DMARCレコード |
| domain | このドメインのDMARCホストレコード |
| value | このドメインのDMARC設定値 |
| verify | 設定成功（trueまたはfalse） |
| create_time | ドメイン作成時間 |
| update_time | ドメイン変更時間 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": [
{
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
],
"count": 1
}
{
"result": [
{
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
],
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます
追加
このインターフェースを使用してドメイン名を追加します。
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/domains
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
ボディパラメータ説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | Yes | ドメイン名。ドメイン形式に準拠し、[0-9a-zA-Z-.] のみを含むことができ、4〜255文字、例: mail.test.best。 |
注意事項
1.各ユーザーは最大5つのドメインを追加できます。
1.各ユーザーは最大5つのドメインを追加できます。
このコードブロックはフローティングウィンドウ内に表示されます
リクエスト例
curl -X POST "https://email.api.engagelab.cc/v1/domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"m1314520.com",
}'
curl -X POST "https://email.api.engagelab.cc/v1/domains"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"m1314520.com",
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
条件を満たすすべてのドメイン情報を返します。
| フィールド | 説明 |
|---|---|
| domain_id | ドメインID |
| name | ドメイン名 |
| type | ドメインタイプ |
| spf | SPFレコード |
| domain | SPFホストレコード |
| value | このドメインのSPF設定値 |
| verify | 設定成功 |
| dkim | DKIMレコード |
| domain | このドメインのDKIMホストレコード |
| value | このドメインのDKIM設定値 |
| verify | 設定成功（trueまたはfalse） |
| mx | MXレコード |
| domain | MXホストレコード |
| value | このドメインのMX設定値 |
| verify | 設定成功（trueまたはfalse） |
| dmarc | DMARCレコード |
| domain | このドメインのDMARCホストレコード |
| value | このドメインのDMARC設定値 |
| verify | 設定成功（trueまたはfalse） |
| create_time | ドメイン作成時間 |
| update_time | ドメイン変更時間 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
}
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-12-15T10:52:05+0800"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
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/domains/{domain_id}
https://email.api.engagelab.cc/v1/domains/{domain_id}
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
ボディパラメータ説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | Yes | 新しいドメイン名。ドメイン形式に準拠し、[0-9a-zA-Z-.] のみを含むことができ、4〜255文字、例: mail.test.best。 |
注意事項
検証済みの設定項目を持つドメインは修正できません。
リクエスト例
curl -X PUT "https://email.api.engagelab.cc/v1/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/domains/22332"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"name":"aizl.net",
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
条件を満たすすべてのドメイン情報を返します。
| フィールド | 説明 |
|---|---|
| domain_id | ドメインID |
| name | ドメイン名 |
| type | ドメインタイプ |
| verify | ドメイン検証値 |
| spf | SPFレコード |
| domain | SPFホストレコード |
| value | このドメインのSPF設定値 |
| verify | 設定成功（trueまたはfalse） |
| dkim | DKIMレコード |
| domain | このドメインのDKIMホストレコード |
| value | このドメインのDKIM設定値 |
| verify | 設定成功 |
| mx | MXレコード |
| domain | MXホストレコード |
| value | このドメインのMX設定値 |
| verify | 設定成功（trueまたはfalse） |
| dmarc | DMARCレコード |
| domain | このドメインのDMARCホストレコード |
| value | このドメインのDMARC設定値 |
| verify | 設定成功（trueまたはfalse） |
| create_time | ドメイン作成時間 |
| update_time | ドメイン変更時間 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-11-22T13:39:05+0800"
}
}
{
"result": {
"domain_id": 147799,
"name": "22edc.com",
"type": 1,
"spf": {
"domain": "22edc.com",
"value": "v=spf1 include:spf.email.engagelab.com -all",
"verify": false
},
"dkim": {
"domain": "mail._domainkey.22edc.com",
"value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
"verify": false
},
"mx": {
"domain": "22edc.com",
"value": "mx1.engagelab.com",
"verify": false
},
"dmarc": {
"domain": "_dmarc.22edc.com",
"value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
"verify": false
},
"create_time": "2022-11-12T15:38:14+0800",
"update_time": "2022-11-22T13:39:05+0800"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
{
"code": 31003,
"message": "Domain name format error"
}
{
"code": 31003,
"message": "Domain name format error"
}
このコードブロックはフローティングウィンドウ内に表示されます
検証
このインターフェースを使用してドメイン名を検証します（データは10分ごとに更新されます）。
URL
https://email.api.engagelab.cc/v1/domains/check
https://email.api.engagelab.cc/v1/domains/check
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | タイプ |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
クエリパラメータ説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | No | ドメイン名。複数の名前は ; で区切ります。 |
注意事項
既存のドメインの設定が合格しているかどうかを返します。
リクエスト例
curl -X POST "https://email.api.engagelab.cc/v1/domains/check?name=aizl.net;m1214520.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X POST "https://email.api.engagelab.cc/v1/domains/check?name=aizl.net;m1214520.com"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
条件を満たすすべてのドメイン情報を返します。
| フィールド | 説明 |
|---|---|
| name | ドメイン名 |
| type | ドメインタイプ |
| config | 設定情報 |
| dkim | 設定合格（trueまたはfalse） |
| mx | 設定合格（trueまたはfalse） |
| spf | 設定合格（trueまたはfalse） |
| dmarc | 設定合格（trueまたはfalse） |
| status | 0は利用不可、1は利用可能、2は合格を示します。 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": [
{
"name": "abc.com",
"type": 1,
"config": {
"dkim": false,
"mx": false,
"spf": false,
"dmarc": false
},
"status": 2,
}
]
}
{
"result": [
{
"name": "abc.com",
"type": 1,
"config": {
"dkim": false,
"mx": false,
"spf": false,
"dmarc": false
},
"status": 2,
}
]
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます
