4. Proceso de Email Transaccional
Aldeamo está en la capacidad de suministrar infraestructura, servicios, interfaz, protocolos y recursos necesarios para el envío de correos electrónicos mediante una integración a través de un Protocolo SMTP o HTTP.
Para la integración de nuestros clientes a la plataforma de E-mail, contamos con un protocolo SMTP y HTTP que permite a nuestros aliados el envío y recepción de mensajes de correo electrónico. Esta tecnología facilita la integración rápida y transparente con el fin de potencializar el negocio de nuestros clientes y asociados.
Aldeamo cuenta con integraciones con proveedores de diferentes servicios de comunicación, principalmente operadores móviles (SMS, Flash SMS), proveedores de servicios de correo electrónico (Gmail, Hotmail, Yahoo etc.) y proveedores de servicios de mensajería OTP (WhatsApp, Facebook Messenger, Twitter, RCS, etc.). La comunicación en cada una de estas integraciones está protegida por los mecanismos de seguridad que ofrezca cada canal, principalmente basados en
TLS 1.2 (HTTPS, SMTPS, VPN).
A continuación, se detalla la tecnología para un mayor entendimiento de su uso y complejidad:
La plataforma de correo electrónico de Aldeamo permite la integración para envío de mensajes originados por su plataforma por medio de dos servicios de integración expuestos de tipo:
A. SMTP.
Aldeamo envía correos electrónicos a través de SMTP, el protocolo de correo electrónico más común en Internet. Puede enviar correo electrónico a través de Aldeamo utilizando una amplia variedad de softwares y lenguajes de programación habilitados para SMTP y poder conectarse a la interfaz y protocolo de Aldeamo.
SMTP es un protocolo de comunicación estándar que tiene 36 años de antigüedad y es utilizado por la gran mayoría de aplicaciones del mundo para poder enviar correo electrónico. Desde Outlook hasta el sistema CRM de su empresa.
El protocolo SMTP es la entrega de correo extremo a extremo desde un servidor de correo a otro. Existe una conexión directa entre un remitente SMTP (el cliente) y el receptor SMTP de destino (el servidor). El cliente SMTP mantiene el correo en el remitente hasta que lo transmite y lo copia satisfactoriamente en el receptor SMTP (servidor).
Para enviar correos electrónicos a través de la interfaz SMTP de Aldeamo, necesitará lo siguiente:
Parámetros:
Parámetro | Descripción | Ejemplo |
---|---|---|
Servidor SMTP | Dirección del servidor de salida de correo electrónico. | smtp.aldeamo.com |
Puerto | Puerto del servidor de salida de correo electrónico. | 2593 |
Usuario | Credenciales. | credenciales@aldeamo.com |
Contraseña | Credenciales. | 3Rh45uY34 |
Registro SPF | Código de autorización en su proveedor de dominios DNS. | v=spf1 include:_spf.aldeamo.com ~all |
*Estas credenciales serán entregadas por su ejecutivo de cuenta encargado.
Valores retornados:
Los valores retornados están implícitos en el protocolo SMTP. De igual manera dentro de la interfaz de Aldeamo, usted podrá configurar la recepción de estadísticas de Apertura y Clics si así lo desea.
Recomendaciones:
- Solicite a su ejecutivo de cuenta encargado el Manual de Integración para E-mail Transaccional en donde se detalla y explica la integración a nuestros servidores.
- Si el sistema en el que está trabajando no cuenta con una integración a través de protocolo SMTP, usted puede implementar una librería propia del sistema que lo permita.
- Si por motivos de seguridad, su acceso a la red es controlado por un Firewall “IPTABLES, SECURITY GROUP”, habilite el puerto SMTP 25 para permitir el tráfico de entrada y salida de correos electrónicos mediante este protocolo.
B. HTTP.
Para la integración de nuestros clientes a la plataforma de Email de Aldeamo contamos con un API que permite a nuestros aliados y recepción de mensajes de correo electrónico. Esta tecnología facilita una integración rápida y transparente con el fin de potencializar el negocio de nuestros
clientes y asociados.
A continuación, se detalla esta tecnología para un mayor entendimiento de su uso y complejidad.
Este api está basado en llamados HTTP POST hechos por el cliente a una URL.
Autenticación: El cliente se autentica por medio de una llave API_KEY que se obtiene desde la plataforma y se envía de la siguiente manera.
{
"Authorization": "Bearer {API_KEY}",
}
Bajo este esquema se debe enviar una petición con la siguiente estructura.
URL para consumir el servicio:
https://api.ckpnd.com:5001/v1/email
http://api.ckpnd.com:5000
Ejemplo de la petición
Conten-Type: application/json
JSON petición:
{
"to": [
{
"email": "recipient@exampledomain.com"
}
],
"options": {
"cc": [
{
"email": "cc@exampledomain.com"
}
],
"bcc": [
{
"email": "bcc@exampledomain.com"
}
]
},
"from": {
"email": "sender@yourdomain.com",
"name": "John Doe"
},
"replyTo": {
"email": "sender@yourdomain.com",
"name": "John Doe"
},
"subject": "Hello World",
"body": "<h1>Hello World</h1>",
"attachments": [
{
"path": "https://i1.wp.com/cms.babbel.news/wpcontent/uploads/2015/05/HEAD02_FRA-20150703094705.gif"
},
{
"path": "http://2.bp.blogspot.com/-DIEPOOz9uqI/UHomvtaAcI/AAAAAAAAAdI/_Nv0WyIXxhA/s1600/P1010411.JPG"
}
]
}
Ejemplo de la petición usando Plantilla
{
"to": [
{
"email": "recipient@exampledomain.com"
}
],
"options": {
"cc": [
{
"email": "cc@exampledomain.com"
}
],
"bcc": [
{
"email": "bcc@exampledomain.com"
}
]
},
"from": {
"email": "sender@yourdomain.com",
"name": "John Doe"
},
"replyTo": {
"email": "sender@yourdomain.com",
"name": "John Doe"
},
"subject": "Hello World",
"template_id": "42eqy7oaigql",
"variables":{
"variable1":"random variable 1",
"variable2":"random variable 2"
}
"attachments": [
{
"path":"https://i1.wp.com/cms.babbel.news/wpcontent/uploads/2015/05/HEAD02_FRA-20150703094705.gif"
},
{
"path":"http://2.bp.blogspot.com/-DIEPOOz9uqI/UHomvtaAcI/AAAAAAAAAdI/_Nv0WyIXxhA/s1600/P1010411.JPG"
}
]
}
Parámetros de la petición
Parámetro | Descripción | Tipo |
---|---|---|
to | Matriz de direcciones de destinatarios. | Array |
Dirección de correo electrónico del destinatario. | String | |
options | Matriz para incluir direcciones en copia y en copia oculta. | Array |
cc | Dirección de correo electrónico del destinatario en copia. | String |
bcc | Dirección de correo electrónico del destinatario en copia oculta. | String |
bcc | Dirección de correo electrónico del destinatario en copia oculta. | String |
subject | Asunto del correo electrónico | String |
body | Contenido del mensaje en HTML | String |
template_id (opcional) | Código de plantilla de Aldeamo. Encuentre el id de plantilla en su usuario de Aldeamo | String |
variables | Variables personalizadas para ser reemplazadas en el contenido del mensaje | Array |
attachments | Matriz de URL de archivo para enviar como adjunto | Array |
path | URL remota del archivo para enviar como archivo adjunto. | String |
Esquema de la respuesta
HTTP/1.1 200 OK
{
"message": "Messages sent!",
"to": [
{
"email": "recipient@exampledomain.com",
"msgid": "40f7f020-4c0c-11e9-870a-51bee176686d"
}
]
}
Parámetros de la respuesta
Parámetro | Descripción | Tipo |
---|---|---|
Dirección de correo electrónico del destinatario. | String | |
msgid | Identificador del mensaje. | String |
Existe una serie de paquetes de software comerciales y de código abierto que admiten el envío de correo electrónico a través de SMTP o HTTP. Estos son algunos:
- Plataformas de Blog.
- Agregadores RSS.
- Software de administración de listas.
- Sistemas de flujo de trabajo.
- Sistemas de gestión de requerimientos.
- CRM.
- CMS.
- ERP.
Puede configurar cualquier software habilitado para protocolos de este tipo disponibles para enviar correo electrónico a través de la interfaz de Aldeamo. Para obtener instrucciones sobre cómo configurar SMTP para un determinado paquete de software, consulte la documentación de dicho software.