Saltar al contenido principal

Webservices relacionados con emails

El concepto de campaña de email define una comunicación por email, personalizada o no, enviada a una selección de perfiles.

Existen dos tipos de campañas:

  • Campañas puntuales (masivas): la campaña se envía de una sola vez a todo el público objetivo.

  • Campañas continuas: la campaña se activa para permitir el envío individual a lo largo del tiempo (especialmente a través de un escenario, pero también completamente a través de la API).

Las llamadas a las APIs disponibles en relación con los emails le permiten:

Crear una campaña de email​

Es posible crear una campaña de email masiva en su totalidad a través de los webservices de Actito. Para ello, será necesario realizar varias llamadas sucesivas para establecer las diferentes etapas de diseño de su campaña. De hecho, deberá seguir un proceso similar a la creación de su campaña a través de la interfaz de Actito.

En cualquier momento, puedes retomar el control de tu campaña a través de la interfaz de Actito.

Configurar una campaña de email puntual​

Para crear y enviar emails masivos completamente a través de la API, te invitamos a seguir el caso de uso Boletín diario en nuestro Portal de Desarrolladores.

Enviar campañas continuas​

A diferencia de las campañas masivas que se envían una sola vez, es posible programar campañas continuas, que permiten el envío continuo de emails en un momento específico para cada perfil.

El funcionamiento de las campañas continuas está automatizado en el sentido de que permiten la automatización del envío de un email basado en un evento desencadenante. A diferencia de los escenarios que se pueden configurar en Actito, el evento desencadenante de las campañas continuas no debe ser definido en la interfaz. El envío se activará directamente mediante una llamada al webservice que podrás programar según el propósito de tu envío continuo (por ejemplo, un email de bienvenida después de un registro, un email de confirmación después de una compra).

Activar una campaña continua​

El envío continuo debe ser preparado previamente, como se detalla en las operaciones anteriores. Luego debe ser activado.

Esto se hace a través de la operación PUT/entity/{e}/mail/{m}/activate

Obtendrás el identificador técnico del envío como respuesta y la campaña se activará.

Contactar a un perfil con un envío continuo​

Cuando un perfil cumple las condiciones relacionadas con el propósito de tu envío continuo, es posible desencadenarlo mediante la operación POST/entity/{e}/mail/{p}/profile{p}

Las variables​

Esta llamada te permite enviar variables relacionadas directamente con el propósito de este envío continuo (por ejemplo, en el caso de una confirmación de pedido, puede ser un monto). Estas variables deben hacer referencia directa a una personalización que hayas incluido en el cuerpo de tu email. De hecho, en el caso de un envío continuo, no es obligatorio definir todas las personalizaciones, a diferencia de los emails masivos. Estas pueden ser "proporcionadas más tarde", es decir, por el evento desencadenante del email continuo.

Definir las variables​

En el contenido de su email, las variables deben ser definidas como una personalización clásica, es decir, con el símbolo '$' seguido del nombre de la personalización entre llaves (por ejemplo: *${maPerso}*).

En la llamada al webservice, deben aparecer en el cuerpo de la solicitud en forma de pares "clave-valor", donde "clave" corresponde al nombre exacto de la personalización y "valor" corresponde al valor que la variable debe tomar en el email.

Ejemplo:

curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" -d "[
{
\"key\": \"amount\",
\"values\": [
\"128\"
]
}
]
" "https://api-pre1.actito.com/v4/entity/actito/mail/203/profile/1147695"