API de email: definición, ventajas y cómo funcionan

¿Estás creando una página web de comercio electrónico que necesita enviar emails transaccionales a los clientes? ¿Te dedicas al desarrollo y estás creando una aplicación web que necesita enviar mensajes a listas de contactos? ¿Profesional del email marketing con la tarea de llegar a decenas de miles de personas mediante envíos masivos de emails segmentados y personalizados? ¿O responsable de equipo que necesita un informe de rendimiento automatizado para ver cómo van tus campañas de email marketing?

Si te identificas con alguno de estos casos, necesitas una API de email.

API de email son una gran parte de lo que hacemos aquí en Mailgun. Por eso, queríamos dedicar un tiempo a desmitificarlas. En este artículo, empezaremos con los conceptos básicos sobre qué es una API de email y sus ventajas. A continuación, analizaremos la diferencia entre usar SMTP y una API de email para enviar tus emails masivos o transaccionales, y repasaremos algunos ejemplos de nuestra API de Mailgun para demostrar cómo las API de email pueden impulsar tu flujo de trabajo.

Empecemos.

Una interfaz de programación de aplicaciones (API, por sus siglas en inglés) es un mecanismo que permite a dos aplicaciones comunicarse entre sí, y brinda a diferentes plataformas la capacidad de acceder a los recursos de la otra sin comprometer la seguridad ni el control.

Una API de email es un tipo específico de API que puedes utilizar para conectar tu aplicación web o plataforma a un proveedor de servicios de envío de emails (ESP) y utilizar sus capacidades dentro del espacio de trabajo de tu propia aplicación. Esto significa que, en lugar de ir al ESP por separado para enviar tu campaña masiva de email de marketing, ahora puedes usar una API de email para enviar mensajes de forma programática desde tu aplicación.

Así es como funciona la API de email de Mailgun:

1. La API de email de Mailgun te permite integrar tu aplicación con Mailgun, un proveedor de servicios de envío de emails centrado en garantizar la entrega de tu email.
2. Desde tu aplicación, puedes usar una solicitud de API para enviar tus mensajes de email. Esta solicitud de API tiene la marca “HTTP” en la imagen de arriba. Más abajo, al hablar de cómo funcionan las API, explicaremos el porqué.
3. Mailgun recibe tu solicitud de envío de email y la compila antes de añadirla a la cola. Los proveedores de servicios de envío de emails transaccionales como Mailgun ayudan a optimizar tus esfuerzos de email al proporcionar resolución de problemas, registros de estado, soluciones de almacenamiento, gestión de respuestas, analíticas de email y entrega optimizada.
4. A continuación, Mailgun entrega tu mensaje a través de la API o del protocolo para transferencia simple de correo (SMTP) a los clientes de email de tus suscriptores, como Microsoft Outlook, AOL, Gmail o Yahoo. Más abajo entraremos en detalle sobre el SMTP.
5. Los clientes de email de tus suscriptores entregan entonces los mensajes en sus bandejas de entrada.

Una API de email marketing es un tipo específico de API de email diseñada para gestionar y automatizar campañas de marketing de forma programática. Te permite enviar emails de promociones, newsletters y automatizaciones basadas en un disparador directamente desde tu aplicación o software. También proporciona herramientas para gestionar listas de suscriptores, personalizar el contenido y obtener analíticas detalladas sobre el rendimiento de la campaña. 

Existen muchas ventajas al usar una API de email en términos de eficiencia, seguridad y escalabilidad. Las ventajas de cualquier API están relacionadas con la agilización de procesos sin comprometer la seguridad, y además conservas la ventaja de operar servicios desde tu propio entorno. Esto hace que sea mucho más fácil extraer métricas y supervisar los informes. Estas son algunas de sus ventajas:

• Mejora de la entregabilidad: las API de email se basan en una infraestructura sólida y cumplen las mejores prácticas que ayudan a que tus mensajes lleguen a las bandejas de entrada deseadas. Al gestionar automáticamente los rebotes y las bajas, la API garantiza que tus listas se mantengan limpias. Esto indica a los proveedores de servicios de envío de emails (ESP) que eres un remitente con buena reputación y reduce la probabilidad de que te marquen como spam. 

• Mayor eficiencia y automatización: la API elimina la necesidad de realizar tareas manuales que consumen mucho tiempo, como la creación y el envío de emails individuales. Esto es especialmente crucial para los emails transaccionales (restablecer contraseñas, confirmaciones de pedidos) y las campañas de marketing a gran escala.  

• Impulso de la personalización y la interacción: las API de email pueden integrarse con los datos de tu clientela para personalizar de forma dinámica el contenido de cada mensaje. Esta capacidad te permite enviar emails muy relevantes que pueden traducirse en mayores tasas de apertura y de clics, así como en una conexión más estrecha con tu clientela. 

• Analíticas y perspectivas en tiempo real: obtén analíticas de email para hacer un seguimiento de las métricas y evaluar tus campañas de email. Usa una API de email para extraer y recopilar métricas de entregabilidad como la tasa de apertura, cuántas personas suscritas hicieron clic en tu botón de llamada a la acción (CTA) o cuántos emails se tradujeron en conversiones. Este ciclo de retroalimentación en tiempo real te permite tomar decisiones basadas en datos y optimizar tus campañas de email para obtener mejores resultados. 

• Seguridad de los datos y cumplimiento normativo: protege tu negocio y a tu clientela con protocolos de seguridad avanzados. Las API de email marketing usan la autenticación segura y el cifrado para salvaguardar los datos sensibles de la clientela.  

• Automatización impulsada por eventos: crea webhooks que envían datos de eventos de email a un CRM. Usa los webhooks para enviar los datos de tus eventos a herramientas externas de gestión de las relaciones con el cliente (CRM). Puedes utilizar las API de email para crear webhooks que te notifiquen cuando se produzca un evento concreto, como cuando alguien solicite restablecer una contraseña, lo que te permitirá programar una acción de seguimiento, como enviar un email para restablecer la contraseña. 

• Escalabilidad: cuando utilices el SMTP para el envío de emails, ten en cuenta tanto tu volumen de envío como la seguridad. Si tu volumen de envío normal se dispara, los clientes de email podrían marcar tu comportamiento como spam. Con las llamadas a la API que pasan por servidores en la nube, no tienes los mismos problemas al operar a gran escala. Además, el SMTP no incluye de forma automática la capacidad de incorporar capas de autenticación; aquí desglosamos más a fondo las diferencias entre API y SMTP 

Bien, ahora ya sabemos qué hace una API de email y cuáles son las ventajas de usarla. ¿Pero cómo funciona? No entraremos en todos los detalles técnicos de las API, pero podemos mostrarte el panorama general. Empezaremos por la arquitectura de una API. A continuación, analizaremos las solicitudes que puedes hacer a una API y las respuestas que recibirás.

Las API de email como la API de Mailgun se ajustan a una convención moderna llamada REST (transferencia de estado representacional), un estilo de arquitectura de API que se centra en la manipulación de recursos. Estos recursos son objetos de datos, como archivos de texto, páginas HTML o conjuntos de datos.

Puedes emitir solicitudes para acceder a estos recursos o modificarlos a través de puntos de conexión de identificadores de recursos uniformes (URI). Los URI son similares a las URL, pero solo sirven para identificar un recurso, mientras que las URL lo localizan.

Por ejemplo, este es el punto de conexión para el envío de emails de la API de email de Mailgun:

                                

                                    v3/<domain>/messages
                                
                            

Puedes enviar solicitudes a este punto de conexión para enviar emails.

Las API RESTful utilizan puntos de conexión para gestionar recursos, y permiten crear, leer, actualizar y eliminar registros al comunicarse con dichos puntos de conexión.

Estos son algunos de los puntos de conexión más populares de Mailgun:

Cuando usas una API, gestionas y actualizas la información mediante la emisión de solicitudes:

• POST crea un recurso nuevo
• GET solicita un recurso
• PUT sustituye un recurso
• PATCH actualiza un recurso
• DELETE elimina un recurso

Estas solicitudes emplean métodos estándar del protocolo de transferencia de hipertexto (HTTP). A veces, verás la expresión “enviar una solicitud HTTP” en lugar de “enviar una solicitud a través de la API”, como en la imagen de la API de Mailgun que aparece más arriba. Ambas significan lo mismo.

A continuación, te mostramos un ejemplo de una solicitud POST enviada al punto de conexión de mensajes de la API de email de Mailgun:

                                

                                    curl -s --user 'api:YOUR_API_KEY' 
n    https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages 
n    -F from='Excited User <mailgun@YOUR_DOMAIN_NAME>' 
n    -F to=foo@example.com 
n    -F to=bar@example.com 
n    -F subject='Hello' 
n    -F text='Testing some Mailgun awesomeness!'
                                
                            

Esta solicitud le indica a la API que envíe un email en texto plano desde Excited User en mailgun@YOUR_DOMAIN_NAME a foo@example.com y bar@example.com. El email tiene como línea de asunto “Hello” y contiene el mensaje “Testing some Mailgun awesomeness!”.

No hay nada peor que enviar emails o líneas de código a ciegas, ¿verdad? Por eso, dependiendo del tipo de solicitud HTTP que envíes, obtendrás un tipo de respuesta específico. La respuesta consistirá en los datos solicitados (como un mensaje de email almacenado que quieres recuperar) o bien en una confirmación de que la acción solicitada se ha llevado a cabo. Las respuestas se formatean en XML, JSON, YAML u otros formatos. Por ejemplo, Mailgun devuelve respuestas en JSON.

Por ejemplo, esta es la respuesta en JSON que deberías recibir de la API de Mailgun si la solicitud POST anterior se envió correctamente:

                                

                                    {rn  "message": "Queued. Thank you.",rn  "id": "<20111114174239.25659.5817@samples.mailgun.org>"rn}
                                
                            

En Mailgun, creemos que la sencillez y la eficiencia son claves para disfrutar de una buena experiencia de email. Puedes usar la API de Mailgun con lenguajes de programación y frameworks como Node.js, curl, Python, PHP, Microsoft.NET, Java, entre otros. Echa un vistazo a nuestras bibliotecas para empezar.

A continuación te presentamos algunos casos de uso de nuestras API de email:

• Usa nuestra API de envío para enviar un email en HTML sin esfuerzo y a gran escala.
• Usa nuestra API de validación de emails para verificar una dirección de email.
• Usa nuestra API de plantillas para crear, subir, almacenar y versionar una plantilla de email en HTML.

Entremos en más detalle sobre cada uno de ellos a continuación.

Usa una solicitud POST para enviar un email en HTML con adjuntos a través de la API de envío de Mailgun.

Empezaremos con el siguiente código:

                                

                                    curl -s --user 'api:YOUR_API_KEY' 
n    https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/messages 
n    -F from='Excited User <YOU@YOUR_DOMAIN_NAME>' 
n    -F to='foo@example.com' 
n    -F cc='bar@example.com' 
n    -F bcc='baz@example.com' 
n    -F subject='Hello' 
n    -F text='Testing some Mailgun awesomeness!' 
n    --form-string html='<html>HTML version of the body</html>' 
n    -F attachment=@files/cartman.jpg 
n    -F attachment=@files/cartman.png
                                
                            

En el ejemplo anterior, hemos enviado un mensaje de Excited User en YOU@YOUR_DOMAIN_NAME a tres destinatarios: foo@example.com, bar@example.com y baz@example.com. Hemos adjuntado el contenido del email en HTML pegándolo directamente entre las etiquetas . También hemos añadido dos adjuntos: cartman.jpg y cartman.png.

Tendrás que sustituir YOUR_API_KEY por la tuya clave de API. Además, ten en cuenta que, si te encuentras en la UE, deberás usar la URL base para nuestro entorno de la UE: https://api.eu.mailgun.net/.

Deberíamos recibir la siguiente respuesta a nuestra llamada a la API:

                                

                                    {rn  "message": "Queued. Thank you.",rn  "id": "<20111114174239.25659.5817@samples.mailgun.org>"rn}
                                
                            

Continuemos con otro caso de uso. Usaremos una solicitud GET para validar una dirección de email a través de la API de validación de emails:

                                

                                    curl --user 'api:PRIVATE_API_KEY' -G 
n    https://api.mailgun.net/v4/address/validate 
n    --data-urlencode address='foo@mailgun.net'
                                
                            

Deberíamos obtener la siguiente respuesta a nuestra llamada a la API:

                                

                                    {rn    "address": "foo@mailgun.net",rn    "is_disposable_address": false,rn    "is_role_address": false,rn    "reason": [],rn    "result": "deliverable",rn    "risk": "low"rn}
                                
                            

Para nuestro último caso de uso, vamos a intentar almacenar una plantilla mediante la emisión de una solicitud POST a través de la API de plantillas:

                                

                                    curl -s --user 'api:YOUR_API_KEY' -X POST 
n      https://api.mailgun.net/v3/YOUR_DOMAIN_NAME/templates 
n      -F name="billing" rn      -F description="template description"rn      -F tag="v0" rn      -F template="template contents"
                                
                            

En esta solicitud, el parámetro name indica el nombre de la plantilla. Se usa para hacer referencia a la plantilla en otras llamadas a la API. El parámetro tag identifica la versión específica de esta plantilla. El parámetro template especifica el propio contenido de la plantilla. Aquí, puedes pegar el contenido HTML de la plantilla directamente en la solicitud.

Deberíamos recibir la siguiente respuesta:

                                

                                    {rn  "template": {rn      "createdAt": "Wed, 29 Aug 2021 23:31:13 UTC",rn      "description": "template description",rn      "name": "billing",rn      "version": {rn          "createdAt": "Wed, 29 Aug 2021 23:31:14 UTC",rn          "tag": "v0",rn      }rn  },rn  "message": "template has been stored"rn}
                                
                            

Las API de email ayudan en la entregabilidad del email al facilitar la mensajería tanto para los remitentes como para los destinatarios. Una API garantiza que un mensaje se envíe a una audiencia predeterminada (normalmente a través de una lista creada por el remitente) y elimina la necesidad de contar con grandes cantidades de mensajes generados de forma manual, lo que consume mucho tiempo.

La reducción del envío manual también garantiza que haya menos errores humanos, como direcciones de email mal escritas o emails que no se envían cuando es necesario. Esto mejora la precisión y la consistencia de los mensajes de email enviados y conduce a mayores niveles de interacción con la audiencia objetivo.

El papel de las API a la hora de mejorar la entregabilidad y la interacción es especialmente importante para las organizaciones que se comunican con grandes audiencias. Si 100 clientes solicitan a una empresa que les restablezca la contraseña de su cuenta en el plazo de una hora, esa demanda sería casi imposible de cubrir si la empresa intentara crear manualmente 100 emails para sus clientes (piensa en el episodio de la fábrica de chocolate de I Love Lucy).

No siempre es fácil entender por completo las API, pero estas hacen que tu programa de email sea más fiable y eficiente. ¿Quieres más información sobre cómo pueden ayudarte las API de email de Mailgun? Echa un vistazo a nuestras documentación de la API o contacta con nuestros especialistas en entregabilidad.

Autor: Mary Dolan Mary Dolan is a former Community Marketing Manager and Copywriter at Sinch Mailgun. She was our social media guru and community leader. She was dialed into the email network and writes about the email topics and trends you're probably talking about.