Dominio
El usuario debe configurar el dominio de correo para enviar correos electrónicos mediante EngageLab.
Se puede consultar, añadir o modificar el dominio.
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, se debe asegurar de que el centro de datos seleccionado corresponda a la URL base adecuada.
POST/v1/domains
Consulta (por lotes)
Consultar el dominio mediante esta interfaz.
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/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 | true | Basic base64(apiUser:apiKey) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| names | string | no | Nombre de dominio. Utilizar ; como separador |
| type | int | no | Tipo de dominio: 0 (dominio de prueba), 1 (dominio común) |
Ejemplo de solicitud
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>>"
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 |
| type | Tipo de dominio |
| verify | Valor de verificación |
| spf | Configuración de SPF |
| domain | Registro de host de SPF |
| value | Valor de configuración de SPF |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| dkim | Configuración de DKIM |
| domain | Registro de host de DKIM |
| value | Valor de configuración de DKIM |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| mx | Configuración de MX |
| domain | Registro de host de MX |
| value | Valor de configuración de MX |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| dmarc | Registro de host de Dmarc |
| domain | Registro de host de Dmarc |
| value | Valor de configuración de Dmarc |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| 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": 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
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Este bloque de código se muestra en una ventana flotante
Añadir
Añadir dominios mediante esta interfaz.
URL
https://email.api.engagelab.cc/v1/domains
https://email.api.engagelab.cc/v1/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 | true | Basic base64(apiUser:apiKey) |
Descripción de parámetros de consulta
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| name | string | sí | Nombre de dominio. Debe ajustarse al formato de nombre de dominio y solo puede contener [0-9a-zA-Z -.], con una longitud de 4 a 255 caracteres, por ejemplo, mail.test.best. |
Consejos:
1. Cada usuario puede añadir hasta 5 dominios
1. Cada usuario puede añadir hasta 5 dominios
Este bloque de código se muestra en una ventana flotante
Ejemplo de solicitud
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",
}'
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
Devuelve información de dominio válida.
| Parámetro | Descripción |
|---|---|
| domain_id | ID de dominio |
| name | Nombre de dominio |
| type | Tipo de dominio |
| spf | Configuración de SPF |
| domain | Registro de host de SPF |
| value | Valor de configuración de SPF |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| dkim | Configuración de DKIM |
| domain | Registro de host de DKIM |
| value | Valor de configuración de DKIM |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| mx | Configuración de MX |
| domain | Registro de host de MX |
| value | Valor de configuración de MX |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| dmarc | Registro de host de Dmarc |
| domain | Registro de host de Dmarc |
| value | Valor de configuración de Dmarc |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| 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": 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"
}
}
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 mediante esta interfaz.
URL
https://email.api.engagelab.cc/v1/domains/{domain_id}
https://email.api.engagelab.cc/v1/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 | true | 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 ajustarse al formato de nombre de dominio y solo puede contener [0-9a-zA-Z -.], con una longitud de 4 a 255 caracteres, por ejemplo, mail.test.best. |
Consejos:
Los dominios con configuración verificada no se pueden modificar
Los dominios con configuración verificada no se pueden modificar
Este bloque de código se muestra en una ventana flotante
Ejemplo de solicitud
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",
}'
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
Devuelve información de dominio válida.
| Parámetro | Descripción |
|---|---|
| domain_id | ID de dominio |
| name | Nombre de dominio |
| type | Tipo de dominio |
| spf | Configuración de SPF |
| domain | Registro de host de SPF |
| value | Valor de configuración de SPF |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| dkim | Configuración de DKIM |
| domain | Registro de host de DKIM |
| value | Valor de configuración de DKIM |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| mx | Configuración de MX |
| domain | Registro de host de MX |
| value | Valor de configuración de MX |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| dmarc | Registro de host de Dmarc |
| domain | Registro de host de Dmarc |
| value | Valor de configuración de Dmarc |
| verify | Si la configuración se ha realizado correctamente (true o false) |
| 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": 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"
}
}
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 mediante esta interfaz.
URL
https://email.api.engagelab.cc/v1/domains/check
https://email.api.engagelab.cc/v1/domains/check
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
Descripción de parámetros
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| name | string | no | Nombre de dominio. Para varios, utilizar ';' como separador. |
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/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>>"
Este bloque de código se muestra en una ventana flotante
Descripción de valores devueltos
Devuelve información de dominio válida.
| Parámetro | Descripción |
|---|---|
| name | Nombre de dominio |
| type | Tipo de dominio |
| config | Objeto de configuración |
| dkim | true o false |
| mx | true o false |
| spf | true o false |
| dmarc | true o false |
| status | 0: no verificado, 1: utilizable, 2: verificado |
Ejemplo de valor devuelto
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
}
]
}
Este bloque de código se muestra en una ventana flotante
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Este bloque de código se muestra en una ventana flotante
