API_USER

API_USER es la cuenta de verificación utilizada para enviar correos electrónicos en EngageLab.

Se puede buscar o agregar API_USER mediante la API.

Dirección de invocación

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 que el centro de datos seleccionado corresponda a la URL base adecuada.

POST /v1/api_users

Consultar (Batch)

Mediante esta interfaz se puede obtener información básica de API_USER.

URL

https://email.api.engagelab.cc/v1/api_users

              
              https://email.api.engagelab.cc/v1/api_users

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
email_type	int	no	Tipo de correo: 0 (trigger), 1 (batch)
api_user_type	int	no	Tipo de api_user: 0 (test), 1 (general)
domain_name	string	no	Nombre de dominio vinculado

Ejemplo de solicitud

curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Descripción de valores devueltos

Campo	Descripción
api_user	API_USER
api_user_type	Tipo de api_user: 0 (test), 1 (general)
email_type	Tipo de correo de API_USER
domain_name	Dominio vinculado a API_USER
click_tracking	Si se habilita el seguimiento de clics: false (deshabilitar), true (habilitar)
open_tracking	Si se habilita el seguimiento de aperturas: false (deshabilitar), true (habilitar)
unsubscribe_tracking	Si se habilita el seguimiento de cancelación de suscripción: false (deshabilitar), true (habilitar)

Ejemplo de valores devueltos

Response-success

HTTP Status: 200

{ "result": [ { "api_user": "xjmfcbatch", "api_user_type": 1, "email_type": 1, "domain_name": "sc.datavalidation.cn", "click_tracking": false, "open_tracking": false, "unsubscribe_tracking": false } ], "count": 85 }

              
              {
    "result": [
            {
                "api_user": "xjmfcbatch",
                "api_user_type": 1,
                "email_type": 1,
                "domain_name": "sc.datavalidation.cn",
                "click_tracking": false,
                "open_tracking": false,
                "unsubscribe_tracking": false
            }
         
        ],
        "count": 85
}

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

Agregar

API_USER y API_KEY son credenciales utilizadas para la autenticación cuando los usuarios invocan la API de EngageLab, y permiten distinguir entre los tipos de correo trigger y batch.

Esta API permite agregar un API_USER y devuelve el API_KEY correspondiente.

Nota: Antes de utilizar esta API para agregar un API_USER, se debe verificar si ya se ha creado un API_USER y un API_KEY. De lo contrario, es necesario iniciar sesión en el backend web para crearlos por primera vez.

URL

https://email.api.engagelab.cc/v1/api_users

              
              https://email.api.engagelab.cc/v1/api_users

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

Encabezado de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	true	Basic base64(api_user:api_key)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
api_user	string	yes	Nombre de API_USER
email_type	int	yes	Tipo de correo: 0 (trigger), 1 (batch)
domain_name	string	yes	Nombre de dominio vinculado a API_USER
track_domain_name	string	no	Nombre de seguimiento vinculado a API_USER
open_tracking	boolean	no	Si se habilita el seguimiento de aperturas: false (deshabilitar), true (habilitar); deshabilitado de forma predeterminada
click_tracking	boolean	no	Si se habilita el seguimiento de clics: false (deshabilitar), true (habilitar); deshabilitado de forma predeterminada
unsubscribe_tracking	boolean	no	Si se habilita el seguimiento de cancelación de suscripción: false (deshabilitar), true (habilitar); habilitado de forma predeterminada

Tips:

1. Seguimiento de cancelaciones de suscripción: el sistema lo habilitará obligatoriamente para los usuarios gratuitos.

              
              1. Seguimiento de cancelaciones de suscripción: el sistema lo habilitará obligatoriamente para los usuarios gratuitos.

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

Ejemplo de solicitud

curl -X POST "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "api_user":"batch_edm", "email_type":1, "domain_name":"aizl.net" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/api_users" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "api_user":"batch_edm",
  "email_type":1,
  "domain_name":"aizl.net"
}'

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

Descripción de valores devueltos

Campo	Descripción
api_user	Nombre de API_USER
api_key	API_KEY
api_user_type	Tipo de API_USER
email_type	Tipo de correo de API_USER
domain_name	Dominio vinculado a API_USER
click_tracking	Si se habilita el seguimiento de clics
open_tracking	Si se habilita el seguimiento de aperturas
unsubscribe_tracking	Si se habilita el seguimiento de cancelación de suscripción

Ejemplo de valores devueltos

Response-success

HTTP Status: 200

{ "result": { "api_user": "xjmfcbatch", "api_user_type": 1, "api_key": "2*****", "email_type": 1, "domain_name": "sc.datavalidation.cn", "click_tracking": false, "open_tracking": false, "unsubscribe_tracking": true } }

              
              {
    "result": {
            "api_user": "xjmfcbatch",
            "api_user_type": 1,
            "api_key": "2*****",
            "email_type": 1,
            "domain_name": "sc.datavalidation.cn",
            "click_tracking": false,
            "open_tracking": false,
            "unsubscribe_tracking": true
    }
}

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

Response-error

HTTP Status :400

{ "code": 31110, "message": "api_user cannot be empty." }

              
              {
    "code": 31110,
    "message": "api_user cannot be  empty."
}

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