Domaine de suivi
Gérez vos domaines de suivi.
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 à la bonne URL de base.
POST/v1/tracking-domains
Requête
Obtenez la liste des domaines de suivi
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-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 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 | non | nom de domaine |
| offset | int | non | position de l'offset, [0-], défaut 0 |
| limit | int | non | quantité, [0-100], défaut 100 |
Exemple de requête
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>>"
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 de domaine |
| cname | détails sur l'enregistrement CNAME du domaine |
| verify | si la configuration est réussie (true ou false) |
| verify_message | message décrivant l'enregistrement CNAME, ou null si l'enregistrement est correct |
| required_record | enregistrement CNAME à configurer |
| existed_record | enregistrement CNAME configuré par l'utilisateur |
| cert | détails sur le certificat du domaine |
| verify | si la configuration est réussie (true ou false) |
| verify_message | le certificat n'a pas été téléchargé, le certificat est en cours de configuration, le certificat est effectif, le certificat a expiré |
| expired_date | date d'expiration |
| 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": 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
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Non autorisé."
}
{
"code": 30000,
"message": "Non autorisé."
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter
Ajoutez un domaine de suivi à votre compte.
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-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 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 |
Astuces :
Vous pouvez ajouter jusqu'à 5 noms de domaines de suivi personnalisés. Le nom de domaine ne peut pas être modifié une fois sa configuration vérifiée. Une configuration incorrecte peut rendre les liens dans les e-mails inaccessibles, entraîner des données de suivi inexactes, etc.
En raison de la mise à niveau de Chrome et d'autres navigateurs, le chargement des ressources HTTP sera interdit à l'avenir, ce qui entraînera une interception incorrecte et des problèmes de données de suivi, etc. Il est fortement recommandé de télécharger des certificats SSL dans la configuration HTTPS et d'activer le suivi HTTPS.
Exemple de requête
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"
}'
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 de domaine |
| cname | détails sur l'enregistrement CNAME du domaine |
| verify | si la configuration est réussie (true ou false) |
| verify_message | message décrivant l'enregistrement CNAME, ou null si l'enregistrement est correct |
| required_record | enregistrement CNAME à configurer |
| existed_record | enregistrement CNAME existant |
| 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": 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": ""
}
}
}
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 les domaines de suivi via cette interface
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
https://email.api.engagelab.cc/v1/tracking-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 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, ne peut contenir que des caractères alphanumériques, des tirets (-) et des points (.), et doit comporter entre 4 et 255 caractères (ex : mail.test.best). |
Exemple de requête
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",
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de valeur retournée
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
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 de suivi via cette interface
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
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
Note
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/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>>"
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 de domaine |
| cname | détails sur l'enregistrement CNAME du domaine |
| verify | si la configuration est réussie (true ou false) |
| verify_message | message décrivant l'enregistrement CNAME, ou null si l'enregistrement est correct |
| required_record | enregistrement CNAME à configurer |
| existed_record | enregistrement CNAME existant |
| cert | détails sur le certificat du domaine |
| verify | si la configuration est réussie (true ou false) |
| verify_message | le certificat n'a pas été téléchargé, le certificat est en cours de configuration, le certificat est effectif, le certificat a expiré |
| expired_date | date d'expiration |
| 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": 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"
}
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Non autorisé."
}
{
"code": 30000,
"message": "Non autorisé."
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter un certificat
Ajoutez le certificat du domaine de suivi
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
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
Description des paramètres du corps
| paramètre | type | obligatoire ou non | description |
|---|---|---|---|
| cert_content | string | oui | Contenu du certificat. La valeur doit être encodée en PEM. |
| cert_key | string | oui | Clé privée du certificat. La valeur doit être encodée en PEM. |
Exemple de requête
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":"...",
}'
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 de domaine |
| cert | détails sur le certificat du domaine |
| verify | si la configuration est réussie (true ou false) |
| verify_message | le certificat n'a pas été téléchargé, le certificat est en cours de configuration, le certificat est effectif, le certificat a expiré |
| expired_date | date d'expiration |
| 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": 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"
}
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Non autorisé."
}
{
"code": 30000,
"message": "Non autorisé."
}
Afficher ce bloc de code dans la fenêtre flottante
Mettre à jour le certificat
Mettez à jour le certificat du domaine de suivi
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
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
Description des paramètres du corps
| paramètre | type | obligatoire ou non | description |
|---|---|---|---|
| cert_content | string | oui | Contenu du certificat. La valeur doit être encodée en PEM. |
| cert_key | string | oui | Clé privée du certificat. La valeur doit être encodée en PEM. |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Non autorisé."
}
{
"code": 30000,
"message": "Non autorisé."
}
Afficher ce bloc de code dans la fenêtre flottante
Mettre à jour API_USER
Mettez à jour le domaine de suivi et la configuration du suivi associés à l'API_USER
URL
https://email.api.engagelab.cc/v1/api_users/{api_user}
https://email.api.engagelab.cc/v1/api_users/{api_user}
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
Description des paramètres du corps
| paramètre | type | obligatoire ou non | description |
|---|---|---|---|
| domain_name | string | non | nom de domaine lié à l'API_USER |
| track_domain_name | string | non | nom du domaine de suivi lié à l'API_USER |
| open_tracking | boolean | non | activer ou non le suivi d'ouverture. Valeurs : false (désactiver), true (activer). Défaut : false. |
| click_tracking | boolean | non | activer ou non le suivi de clics. Valeurs : false (désactiver), true (activer). Défaut : false. |
| unsubscribe_tracking | boolean | non | activer ou non le suivi de désabonnement. Valeurs : false (désactiver), true (activer). Défaut : true. |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Réponse-succès
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Non autorisé."
}
{
"code": 30000,
"message": "Non autorisé."
}
Afficher ce bloc de code dans la fenêtre flottante
