Domaine
L'utilisateur doit configurer le domaine de messagerie pour envoyer des e-mails via EngageLab.
Vous pouvez interroger, ajouter ou modifier le domaine.
Adresse d'appel
| Centre de données | URL |
|---|---|
| Singapour | https://email.api.engagelab.cc |
| Turquie | https://emailapi-tr.engagelab.com |
Lors de l'utilisation de l'API REST, assurez-vous que le centre de données sélectionné correspond à l'URL de base appropriée.
POST/v1/domains
Requête (lot)
Interrogez le domaine via cette interface.
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/domains
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(apiUser:apiKey) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| names | string | non | nom de domaine. Utilisez ; pour séparer |
| type | int | non | type de domaine : 0 (domaine de test), 1 (domaine commun) |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| domain_id | ID du domaine |
| name | nom du domaine |
| type | type de domaine |
| verify | valeur de vérification |
| spf | configuration du SPF |
| domain | enregistrement hôte du SPF |
| value | valeur de configuration du SPF |
| verify | si la configuration est réussie (true ou false) |
| dkim | configuration du DKIM |
| domain | enregistrement hôte du DKIM |
| value | valeur de configuration du DKIM |
| verify | si la configuration est réussie (true ou false) |
| mx | configuration du MX |
| domain | enregistrement hôte du MX |
| value | valeur de configuration du MX |
| verify | si la configuration est réussie (true ou false) |
| dmarc | enregistrement hôte du Dmarc |
| domain | enregistrement hôte du Dmarc |
| value | valeur de configuration du Dmarc |
| verify | si la configuration est réussie (true ou false) |
| create_time | date de création du domaine |
| update_time | date de modification du domaine |
Exemple de valeur retournée
Réponse-succès
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
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Échec de l'authentification."
}
{
"code": 30000,
"message": "Échec de l'authentification."
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter
Ajoutez des domaines via cette interface
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/domains
Afficher ce bloc de code dans la fenêtre flottante
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
POST
POST
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(apiUser:apiKey) |
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| name | string | oui | nom de domaine. Il doit respecter le format de nom de domaine et ne peut contenir que [0-9a-zA-Z -.], 4~255 caractères, tel que mail.test.best. |
Astuces :
1. Chaque utilisateur peut ajouter jusqu'à 5 domaines
1. Chaque utilisateur peut ajouter jusqu'à 5 domaines
Afficher ce bloc de code dans la fenêtre flottante
Exemple de requête
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",
}'
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
Retourne les informations du domaine éligible.
| Paramètre | Description |
|---|---|
| domain_id | ID du domaine |
| name | nom du domaine |
| type | type de domaine |
| spf | configuration du SPF |
| domain | enregistrement hôte du SPF |
| value | valeur de configuration du SPF |
| verify | si la configuration est réussie (true ou false) |
| dkim | configuration du DKIM |
| domain | enregistrement hôte du DKIM |
| value | valeur de configuration du DKIM |
| verify | si la configuration est réussie (true ou false) |
| mx | configuration du MX |
| domain | enregistrement hôte du MX |
| value | valeur de configuration du MX |
| verify | si la configuration est réussie (true ou false) |
| dmarc | enregistrement hôte du Dmarc |
| domain | enregistrement hôte du Dmarc |
| value | valeur de configuration du Dmarc |
| verify | si la configuration est réussie (true ou false) |
| create_time | date de création du domaine |
| update_time | date de modification du domaine |
Exemple de valeur retournée
Réponse-succès
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"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
{
"code": 31003,
"message": "Erreur de format du nom de domaine"
}
{
"code": 31003,
"message": "Erreur de format du nom de domaine"
}
Afficher ce bloc de code dans la fenêtre flottante
Modifier
Modifiez des domaines via cette interface
URL
https://email.api.engagelab.cc/v1/domains/{domain_id}
https://email.api.engagelab.cc/v1/domains/{domain_id}
Afficher ce bloc de code dans la fenêtre flottante
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
PUT
PUT
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(apiUser:apiKey) |
Description des paramètres du corps
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| name | string | oui | nom de domaine. Il doit respecter le format de nom de domaine et ne peut contenir que [0-9a-zA-Z -.], 4~255 caractères, tel que mail.test.best. |
Astuces :
Les domaines avec une configuration vérifiée ne peuvent pas être modifiés
Les domaines avec une configuration vérifiée ne peuvent pas être modifiés
Afficher ce bloc de code dans la fenêtre flottante
Exemple de requête
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",
}'
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
Retourne les informations du domaine éligible.
| Paramètre | Description |
|---|---|
| domain_id | ID du domaine |
| name | nom du domaine |
| type | type de domaine |
| spf | configuration du SPF |
| domain | enregistrement hôte du SPF |
| value | valeur de configuration du SPF |
| verify | si la configuration est réussie (true ou false) |
| dkim | configuration du DKIM |
| domain | enregistrement hôte du DKIM |
| value | valeur de configuration du DKIM |
| verify | si la configuration est réussie (true ou false) |
| mx | configuration du MX |
| domain | enregistrement hôte du MX |
| value | valeur de configuration du MX |
| verify | si la configuration est réussie (true ou false) |
| dmarc | enregistrement hôte du Dmarc |
| domain | enregistrement hôte du Dmarc |
| value | valeur de configuration du Dmarc |
| verify | si la configuration est réussie (true ou false) |
| create_time | date de création du domaine |
| update_time | date de modification du domaine |
Exemple de valeur retournée
Réponse-succès
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"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
{
"code": 31003,
"message": "Erreur de format du nom de domaine"
}
{
"code": 31003,
"message": "Erreur de format du nom de domaine"
}
Afficher ce bloc de code dans la fenêtre flottante
Vérifier
Vérifiez les domaines via cette interface
URL
https://email.api.engagelab.cc/v1/domains/check
https://email.api.engagelab.cc/v1/domains/check
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
Description des paramètres
| paramètre | type | obligatoire ou non | description |
|---|---|---|---|
| name | string | non | nom de domaine. Plusieurs utilisent ';' pour séparer. |
Remarque
Retourne les domaines avec une configuration vérifiée.
Retourne les domaines avec une configuration vérifiée.
Afficher ce bloc de code dans la fenêtre flottante
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description de la valeur retournée
Retourne les informations du domaine éligible.
| Paramètre | Description |
|---|---|
| name | nom du domaine |
| type | type de domaine |
| config | objet de configuration |
| dkim | true ou false |
| mx | true ou false |
| spf | true ou false |
| dmarc | true ou false |
| status | 0:non vérifié ,1:utilisable 2:Vérifié |
Exemple de valeur retournée
Réponse-succès
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
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Échec de l'authentification."
}
{
"code": 30000,
"message": "Échec de l'authentification."
}
Afficher ce bloc de code dans la fenêtre flottante
