La API de Sendkit permite enviar correos electrónicos utilizando una plantilla de Sendkit y personalizar su contenido para cada destinatario.
Para utilizar una plantilla y transmitir datos de personalización, se necesitan los dos encabezados siguientes:
X-SKT-TEMPLATE : permite seleccionar la plantilla de Sendkit que se va a utilizar.
X-SKT-SUB : permite transmitir los datos de personalización de cada destinatario.
Es necesario que la plantilla utilizada se haya creado en Sendkit y, después, en «Mis campañas». De hecho, no es posible llamar directamente a un modelo de Studio a través de la API. Sin embargo, puede crear una plantilla de Sendkit utilizando un modelo de Studio como base.
En el siguiente ejemplo:
la plantilla utilizada se llama name1;
los campos de personalización son FirstName y LastName.
curl --request POST \
--url https://api.sarbacane.com/sendkit/email/send \
--header 'content-type: application/json' \
--header 'x-apikey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--data '{
"to": [
{
"address": "[email protected]"
}
],
"msg": {
"from": {
"address": "[email protected]",
"personalName": "Frank Sender"
},
"replyTo": {
"personalName": "Frank Sender",
"address": "[email protected]"
},
"subject": ".",
"html": "."
},
"headers": {
"X-SKT-TEMPLATE": "name1",
"X-SKT-SUB": [
{
"email": "[email protected]",
"values": {
"FirstName": "John",
"LastName": "Doe"
},
"meta": {
"orderId": 1234567890,
"shipmentId": 123456789
}
}
],
"X-SKT-TEXTVERSION": 1,
"X-SKT-TAGS": [
"Test",
"Sendkit",
"Shipping",
"Hello"
]
}
}'
Importante : el campo html es obligatorio
En el ejemplo anterior, el contenido es simplemente ".", ya que será reemplazado automáticamente por el contenido de la plantilla indicada en X-SKT-TEMPLATE.
El encabezado X-SKT-SUB permite transmitir datos específicos a cada destinatario.
Se puede utilizar, en particular, para:
reemplazar variables dinámicas;
personalizar el contenido del correo electrónico para cada destinatario;
añadir datos empresariales;
personalizar el asunto;
gestionar contenido condicional;
transmitir datos que no se muestran en el correo electrónico.
Las posibilidades son numerosas. Por ejemplo, puede utilizar los datos de su sistema de información para:
mostrar productos complementarios;
modificar determinados elementos del contenido o del CSS;
generar un asunto diferente para cada destinatario;
mostrar información relacionada con un pedido o una entrega.
Puede añadir variables al contenido de su plantilla.
Por ejemplo:
Hola {{FirstName}} {{LastName}},
A continuación, transmita los valores correspondientes en X-SKT-SUB:
"values": {
"FirstName": "John",
"LastName": "Doe"
}
El header X-SKT-META le permite añadir elementos personalizados en forma de pares clave-valor. Los elementos incluidos en el header meta no están presentes en el correo electrónico de destino. Solo los webhooks le permiten recuperar esta información y procesarla en su sistema.
Por ejemplo, puede contener:
un identificador de usuario;
un número de pedido;
un identificador de entrega;
cualquier otro dato que permita establecer la conexión con su sistema de información.
Ejemplo:
"meta": {
"unique_id": "987654321",
"order_id": "132456798",
"shipment_id": "1237498798"
}
Tenga en cuenta que, si una clave existe tanto en X-SKT-META como en X-SKT-SUB, el valor de SUB tiene prioridad.
El encabezado X-SKT-TEXTVERSION permite generar automáticamente una versión de texto a partir del contenido HTML del correo electrónico.
Ejemplo:
"X-SKT-TEXTVERSION": 1
El encabezado X-SKT-TAGS permite asociar etiquetas al correo electrónico para filtrar y analizar las estadísticas en Sendkit. De este modo, puede diferenciar los correos electrónicos de tipo «restablecimiento de contraseña» o de «bienvenida», o según su procedencia. Las etiquetas, por supuesto, no son visibles para sus destinatarios.
Máximo de 5 etiquetas por correo electrónico;
solo se conservan las 5 primeras etiquetas;
máximo de 50 caracteres alfanuméricos por etiqueta;
no se permiten caracteres especiales (@, -, ,, etc.).
Ejemplo:
"X-SKT-TAGS": [
"Test",
"Sendkit",
"Shipping",
"Hello"
]
De forma predeterminada, el dominio de envío se deduce de la dirección del remitente.
La cabecera X-SKT-DOMAIN permite forzar el dominio utilizado para el envío.
Ejemplo:
"X-SKT-DOMAIN": "sendkit.example.com"
Importante : si el dominio indicado no está completamente configurado y validado en Sendkit, se podrá utilizar un dominio compartido para el envío.
El encabezado X-SKT-TRACKING permite activar o desactivar el seguimiento de las interacciones con el correo electrónico.
Permite gestionar, entre otras cosas:
el seguimiento de las aperturas;
el seguimiento de los clics.
Ejemplo:
"X-SKT-TRACKING": {
"html": {
"open": 1,
"click": 1
},
"text": {
"click": 1
}
}
El encabezado X-SKT-GOOGLEANALYTICS permite activar y personalizar el seguimiento de Google Analytics en los enlaces incluidos en el correo electrónico.
Ejemplo :
"X-SKT-GOOGLEANALYTICS": {
"enable": "1",
"utm_source": "Sendkit_Support",
"utm_medium": "email",
"utm_content": "Test_Sending",
"utm_campaign": "Have_a_look"
}
Los parámetros UTM permiten identificar la procedencia y el contexto de los clics en sus herramientas de análisis.
Encabezado | Uso |
X-SKT-TEMPLATE | Seleccionar la plantilla de Sendkit que se va a utilizar |
X-SKT-SUB | Personalizar el correo electrónico para cada destinatario |
X-SKT-META | Añadir datos globales accesibles mediante webhooks |
X-SKT-TEXTVERSION | Generar una versión de texto a partir del HTML |
X-SKT-TAGS | Añadir etiquetas para filtrar y analizar las estadísticas |
X-SKT-DOMAIN | Forzar el dominio de envío |
X-SKT-TRACKING | Configurar el seguimiento de aperturas y clics |
X-SKT-GOOGLEANALYTICS | Configurar el seguimiento de Google Analytics |
Con X-SKT-TEMPLATE y X-SKT-SUB, puede utilizar una plantilla de Sendkit y personalizar dinámicamente su contenido para cada destinatario.
