Tracking Domain

Gestionar sus dominios de seguimiento.

Dirección de la solicitud

Centro de datos	URL
Singapur	https://email.api.engagelab.cc
Turquía	https://emailapi-tr.engagelab.com

Al utilizar la API REST, asegúrese de que el centro de datos seleccionado corresponda a la URL base adecuada.

POST /v1/tracking-domains

Consulta

Obtener la lista de dominios de seguimiento.

URL

https://email.api.engagelab.cc/v1/tracking-domains

              
              https://email.api.engagelab.cc/v1/tracking-domains

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(apiUser:apiKey)

Descripción de parámetros de consulta

Parámetro	Tipo	Obligatorio o no	Descripción
name	string	no	Nombre de dominio
offset	int	no	Posición de offset, [0-], valor predeterminado: 0
limit	int	no	Cantidad, [0-100], valor predeterminado: 100

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Descripción de valores devueltos

Parámetro	Descripción
domain_id	ID de dominio
name	Nombre de dominio
cname	Detalles sobre el registro CNAME del dominio
verify	Si la configuración se ha realizado correctamente (true o false)
verify_message	Mensaje que describe el registro CNAME, o null si el registro es correcto
required_record	Registro CNAME que se debe configurar
existed_record	Registro CNAME configurado por el usuario
cert	Detalles sobre el certificado del dominio
verify	Si la configuración se ha realizado correctamente (true o false)
verify_message	El certificado no se ha cargado; el certificado se está configurando; el certificado ha surtido efecto; el certificado ha caducado
expired_date	Fecha de caducidad
create_time	Hora de creación del dominio
update_time	Hora de modificación del dominio

Ejemplo de valor devuelto

Response-success

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
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Unauthorized." }

              
              { 
    "code": 30000,
    "message": "Unauthorized."
}

Este bloque de código se muestra en una ventana flotante

Añadir

Añadir un dominio de seguimiento a su cuenta.

URL

https://email.api.engagelab.cc/v1/tracking-domains

              
              https://email.api.engagelab.cc/v1/tracking-domains

Este bloque de código se muestra en una ventana flotante

Content-Type:

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

POST

              
              POST

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(apiUser:apiKey)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
name	string	sí	Nombre de dominio

Consejos

Se pueden añadir hasta 5 nombres de dominio de seguimiento personalizados. El nombre de dominio no se puede modificar una vez verificada su configuración. Una configuración incorrecta puede provocar que no se pueda hacer clic en los enlaces de los correos electrónicos, que los datos de seguimiento sean inexactos, etc.
Debido a las actualizaciones de Chrome y otros navegadores, la carga de recursos HTTP se bloqueará en el futuro. Esto puede provocar un marcado incorrecto del contenido (p. ej., como no seguro) y generar problemas en los datos de seguimiento. Se recomienda encarecidamente cargar certificados SSL en la configuración HTTPS y habilitar el seguimiento HTTPS.

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Descripción de valores devueltos

Parámetro	Descripción
domain_id	ID de dominio
name	Nombre de dominio
cname	Detalles sobre el registro CNAME del dominio
verify	Si la configuración se ha realizado correctamente (true o false)
verify_message	Mensaje que describe el registro CNAME, o null si el registro es correcto
required_record	Registro CNAME que se debe configurar
existed_record	Registro CNAME existente
create_time	Hora de creación del dominio
update_time	Hora de modificación del dominio

Ejemplo de valor devuelto

Response-success

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

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status: 400

{ "code": 31003, "message": "Domain name format error" }

              
              {
    "code": 31003,
    "message": "Domain name format error"
}

Este bloque de código se muestra en una ventana flotante

Modificar

Modificar dominios de seguimiento mediante esta interfaz.

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}

              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}

Este bloque de código se muestra en una ventana flotante

Content-Type:

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(apiUser:apiKey)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
name	string	sí	Nombre de dominio. Debe cumplir el formato de nombre de dominio; solo puede contener caracteres alfanuméricos, guiones (-) y puntos (.), y debe tener entre 4 y 255 caracteres (p. ej., mail.test.best).

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Ejemplo de valor devuelto

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status: 400

{ "code": 31003, "message": "Domain name format error" }

              
              {  
    "code": 31003,
    "message": "Domain name format error"
}

Este bloque de código se muestra en una ventana flotante

Verificar

Verificar dominios de seguimiento mediante esta interfaz.

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify

              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Nota

Devuelve los dominios con configuración verificada.

              
              Devuelve los dominios con configuración verificada.

Este bloque de código se muestra en una ventana flotante

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Descripción de valores devueltos

Parámetro	Descripción
domain_id	ID de dominio
name	Nombre de dominio
cname	Detalles sobre el registro CNAME del dominio
verify	Si la configuración se ha realizado correctamente (true o false)
verify_message	Mensaje que describe el registro CNAME, o null si el registro es correcto
required_record	Registro CNAME que se debe configurar
existed_record	Registro CNAME existente
cert	Detalles sobre el certificado del dominio
verify	Si la configuración se ha realizado correctamente (true o false)
verify_message	El certificado no se ha cargado; el certificado se está configurando; el certificado ha surtido efecto; el certificado ha caducado
expired_date	Fecha de caducidad
create_time	Hora de creación del dominio
update_time	Hora de modificación del dominio

Ejemplo de valor devuelto

Response-success

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

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

Este bloque de código se muestra en una ventana flotante

Añadir certificado

Añadir el certificado del dominio de seguimiento.

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert

              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert

Este bloque de código se muestra en una ventana flotante

Content-Type:

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

POST

              
              POST

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
cert_content	string	sí	Representa el contenido del certificado. El valor debe estar codificado en PEM.
cert_key	string	sí	Representa la clave privada del certificado. El valor debe estar codificado en PEM.

Ejemplo de solicitud

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":"...",
}'

Este bloque de código se muestra en una ventana flotante

Descripción de valores devueltos

Parámetro	Descripción
domain_id	ID de dominio
name	Nombre de dominio
cert	Detalles sobre el certificado del dominio
verify	Si la configuración se ha realizado correctamente (true o false)
verify_message	El certificado no se ha cargado; el certificado se está configurando; el certificado ha surtido efecto; el certificado ha caducado
expired_date	Fecha de caducidad
create_time	Hora de creación del dominio
update_time	Hora de modificación del dominio

Ejemplo de valor devuelto

Response-success

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

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

Este bloque de código se muestra en una ventana flotante

Actualizar certificado

Actualizar el certificado del dominio de seguimiento.

URL

https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert

              
              https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert

Este bloque de código se muestra en una ventana flotante

Content-Type:

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
cert_content	string	sí	Representa el contenido del certificado. El valor debe estar codificado en PEM.
cert_key	string	sí	Representa la clave privada del certificado. El valor debe estar codificado en PEM.

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

Este bloque de código se muestra en una ventana flotante

Actualizar API_USER

Actualizar el dominio de seguimiento y la configuración del conmutador de seguimiento asociados con API_USER.

URL

https://email.api.engagelab.cc/v1/api_users/{api_user}

              
              https://email.api.engagelab.cc/v1/api_users/{api_user}

Este bloque de código se muestra en una ventana flotante

Content-Type:

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
domain_name	string	no	El nombre de dominio vinculado al API_USER
track_domain_name	string	no	El nombre de dominio de seguimiento vinculado al API_USER
open_tracking	boolean	no	Si se habilita el seguimiento de aperturas. Valores: false (deshabilitar), true (habilitar). Valor predeterminado: false.
click_tracking	boolean	no	Si se habilita el seguimiento de clics. Valores: false (deshabilitar), true (habilitar). Valor predeterminado: false.
unsubscribe_tracking	boolean	no	Si se habilita el seguimiento de cancelaciones de suscripción. Valores: false (deshabilitar), true (habilitar). Valor predeterminado: true.

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status: 401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

Este bloque de código se muestra en una ventana flotante

Dominio de seguimiento

Dirección de la solicitud

Consulta

Añadir

Modificar

Verificar

Añadir certificado

Actualizar certificado

Actualizar API_USER