APIs de e-mail: definição, benefícios e como funcionam

Você está criando uma página da web de e-commerce que precisa enviar e-mails transacionais para os clientes? Um profissional de desenvolvimento criando um aplicativo da web que precisa enviar mensagens para listas de e-mails? Um profissional de e-mail marketing responsável por alcançar dezenas de milhares de clientes por meio de disparos de e-mail segmentados e personalizados? Ou alguém na gerência que precisa de um relatório de desempenho automatizado para ver como estão indo suas campanhas de e-mail marketing?

Se você se encaixa em alguma dessas situações, você precisa de uma API de e-mail.

APIs de e-mail são uma grande parte do que fazemos aqui no Mailgun. Por isso, queríamos reservar um tempo para desmistificá-las para você. Neste artigo, começaremos com o básico sobre o que é uma API de e-mail e seus benefícios. Em seguida, analisaremos a diferença entre usar SMTP e uma API de e-mail para enviar seus e-mails em massa ou transacionais e veremos alguns exemplos da nossa API do Mailgun para demonstrar como as APIs de e-mail podem impulsionar o seu fluxo de trabalho.

Vamos começar.

Uma interface de programação de aplicativos (API) é um mecanismo que permite que dois aplicativos conversem entre si e dá a diferentes plataformas a capacidade de acessar os recursos umas das outras sem comprometer a segurança ou o controle.

Uma API de e-mail é um tipo específico de API que você pode usar para conectar seu aplicativo ou plataforma da web a um provedor de serviços de e-mail (ESP) e utilizar seus recursos no espaço de trabalho do seu próprio aplicativo. Isso significa que, em vez de navegar para o ESP separadamente para enviar seu disparo de e-mail de marketing, agora você pode usar uma API de e-mail para enviar mensagens de maneira programática em seu aplicativo.

Veja como funciona a API de e-mail do Mailgun em detalhes:

1. A API de e-mail do Mailgun permite integrar o seu aplicativo ao Mailgun, um provedor de serviços de e-mail focado em garantir a entrega do seu e-mail.
2. Em seu aplicativo, você pode usar uma solicitação de API para enviar suas mensagens de e-mail. Esta solicitação de API está rotulada como “HTTP” acima. Falaremos sobre o motivo disso abaixo, quando abordarmos como as APIs funcionam.
3. O Mailgun recebe sua solicitação de envio de e-mail e a compila antes de adicioná-la à fila. Provedores de serviços de e-mail transacional como o Mailgun ajudam a otimizar seus esforços de e-mail ao fornecer solução de problemas, logs de status, soluções de armazenamento, tratamento de respostas, análises de e-mail e entrega otimizada.
4. Em seguida, o Mailgun entrega sua mensagem via API ou Simple Mail Transfer Protocol (SMTP) aos clientes de e-mail dos seus assinantes, como Microsoft Outlook, AOL, Gmail ou Yahoo. Entraremos em mais detalhes sobre o SMTP abaixo.
5. Os clientes de e-mail dos seus assinantes então entregam as mensagens em suas caixas de entrada.

Uma API de e-mail marketing é um tipo específico de API de e-mail desenvolvida para gerenciar e automatizar campanhas de marketing de maneira programática. Ela permite enviar e-mails de promoções, newsletters e automações baseadas em gatilhos diretamente de seu aplicativo ou software. Ela também fornece ferramentas para gerenciar listas de assinantes, personalizar conteúdo e obter análises detalhadas sobre o desempenho da campanha. 

Existem muitos benefícios em usar uma API de e-mail em termos de eficiência, segurança e escalabilidade. Os benefícios de qualquer API estão relacionados à otimização de processos sem comprometer a segurança, e você retém o benefício de operar serviços em seu próprio ambiente. Isso torna muito mais fácil extrair métricas e supervisionar relatórios. Estes são alguns dos benefícios:

• Melhore a entregabilidade: as APIs de e-mail são desenvolvidas em infraestrutura robusta e aderem a práticas recomendadas que ajudam suas mensagens a chegar às caixas de entrada pretendidas. Ao lidar automaticamente com devoluções e cancelamentos de inscrição, a API garante que suas listas permaneçam limpas, o que sinaliza aos provedores de serviços de e-mail (ESPs) que você é um remetente confiável e reduz a probabilidade de suas mensagens serem sinalizadas como spam. 

• Melhore a eficiência e a automação: a API elimina a necessidade de tarefas manuais e demoradas, como a criação e o envio de e-mails individuais. Isso é particularmente crucial para e-mails transacionais (redefinições de senha, confirmações de pedido) e campanhas de marketing em grande escala.  

• Aumente a personalização e o engajamento: as APIs de e-mail podem se integrar aos dados do cliente para personalizar o conteúdo de cada mensagem dinamicamente. Essa capacidade permite enviar e-mails altamente relevantes que podem levar a maiores taxas de abertura, taxas de cliques e a uma conexão mais forte com seus clientes. 

• Análises e insights em tempo real: obtenha análises de e-mail para monitorar métricas e avaliar suas campanhas de e-mail. Use uma API de e-mail para extrair e compilar métricas de entregabilidade, como a taxa de abertura, o número de assinantes que clicaram no seu botão de CTA ou quantos e-mails resultaram em conversão. Esse ciclo de feedback em tempo real permite que você tome decisões orientadas por dados e otimize suas campanhas de e-mail para obter melhores resultados. 

• Garanta a segurança e conformidade de dados: proteja o seu negócio e sua clientela com protocolos de segurança avançados. As APIs de e-mail marketing usam autenticação e criptografia seguras para proteger dados confidenciais do cliente.  

• Ative a automação baseada em eventos: crie webhooks que enviam dados de eventos de e-mail para um CRM. Use webhooks para enviar seus dados de eventos para ferramentas externas de Customer Relationship Management (CRM). Você pode usar APIs de e-mail para criar webhooks que notificam quando um evento específico ocorreu, como um assinante solicitando uma redefinição de senha, o que permite programar uma ação de acompanhamento, como o envio de um e-mail de redefinição de senha. 

• Escalabilidade: ao usar SMTP para o envio de e-mails, considere o seu volume de envio e a segurança. Se o seu volume normal de envio atingir picos repentinos, os clientes de e-mail poderão sinalizar seu comportamento como spam. Com as chamadas de API que passam por servidores em nuvem, você não tem os mesmos problemas ao operar em grande escala. Além disso, o SMTP não possui automaticamente a capacidade de integrar camadas de autenticação, detalhamos mais sobre API vs SMTP aqui 

Certo, agora sabemos o que faz uma API de e-mail e os benefícios de usar uma. Mas como ela funciona? Não entraremos em todos os detalhes das APIs, mas podemos mostrar a você o panorama geral. Começaremos com a arquitetura de uma API. Em seguida, discutiremos as solicitações que você pode fazer a uma API e as respostas que receberá.

APIs de e-mail como a API do Mailgun seguem uma convenção moderna chamada REST (REpresentational State Transfer), um estilo arquitetural de API centrado na manipulação de recursos. Esses recursos são objetos de dados como arquivos de texto, páginas HTML ou conjuntos de dados.

Você pode emitir solicitações para acessar ou modificar esses recursos por meio de endpoints de Unique Resource Indicator (URI). As URIs são semelhantes aos URLs, mas só conseguem identificar um recurso, enquanto os URLs localizam o recurso.

Por exemplo, este é o endpoint de envio de e-mail da API de e-mail do Mailgun:

                                

                                    v3/<domain>/messages
                                
                            

Você pode enviar solicitações para esse endpoint para enviar e-mails.

As APIs RESTful usam endpoints para gerenciar recursos e permitem ao usuário criar, ler, atualizar e excluir registros ao se comunicar com esses endpoints.

Estes são alguns dos endpoints populares do Mailgun:

Ao usar uma API, você gerencia e atualiza por meio de solicitações:

• POST cria um novo recurso
• GET solicita um recurso
• PUT substitui um recurso
• PATCH atualiza um recurso
• DELETE exclui um recurso

Essas solicitações usam os métodos padrão do Hypertext Transfer Protocol (HTTP). Às vezes, você verá os termos “enviar uma solicitação HTTP” em vez de “enviar uma solicitação via API”, como na imagem da API do Mailgun acima. Ambos significam a mesma coisa.

Aqui está um exemplo de uma solicitação POST enviada para o endpoint de mensagens da API de e-mail do 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 solicitação instrui a API a enviar um e-mail em texto simples do Usuário Empolgado em mailgun@YOUR_DOMAIN_NAME para foo@example.com e bar@example.com. O e-mail tem a linha de assunto “Hello” e contém a mensagem “Testing some Mailgun awesomeness!”

Não há nada pior do que disparar e-mails ou linhas de código no escuro, não é? É por isso que, dependendo do tipo de solicitação HTTP enviada, você receberá um tipo específico de resposta. A resposta será os dados solicitados (como uma mensagem de e-mail armazenada que você deseja recuperar) ou a confirmação de que a ação solicitada foi realizada. As respostas são formatadas em XML, JSON, YAML ou outros formatos. O Mailgun, por exemplo, retorna respostas em JSON.

Por exemplo, esta é a resposta em JSON que você deve receber da API do Mailgun se a solicitação POST acima foi enviada corretamente:

                                

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

No Mailgun, acreditamos que a facilidade e a eficiência são essenciais para uma boa experiência de e-mail. Você pode usar a API do Mailgun com linguagens de programação e frameworks como Node.js, curl, Python, PHP, Microsoft.NET, Java e mais. Confira nossas bibliotecas para começar.

Aqui estão alguns casos de uso das nossas APIs de e-mail:

• Use nossa Sending API para enviar um e-mail em HTML sem esforço e em grande escala.
• Use nossa API de validação de e-mail para verificar um endereço de e-mail.
• Use nossa Templates API para criar, fazer upload, armazenar e versionar um modelo de e-mail em HTML.

Abaixo entraremos em mais detalhes sobre cada um deles.

Use uma solicitação POST na Sending API do Mailgun para enviar um e-mail em HTML com anexos.

Começaremos com o seguinte 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
                                
                            

No exemplo acima, enviamos uma mensagem do Usuário Empolgado em YOU@YOUR_DOMAIN_NAME para três destinatários: foo@example.com, bar@example.com e baz@example.com. Anexamos o conteúdo do e-mail em HTML colando-o diretamente entre as tags . Também adicionamos dois anexos: cartman.jpg e cartman.png.

Você precisará substituir YOUR_API_KEY pela sua própria chave de API. Lembre-se também de que, se você for um usuário da UE, deve usar o URL base do nosso ambiente na UE: https://api.eu.mailgun.net/.

Devemos receber a seguinte resposta para a nossa chamada de API:

                                

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

Vamos passar para outro caso de uso. Usaremos uma solicitação GET para validar um endereço de e-mail usando a API de validação de e-mail:

                                

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

Devemos receber a seguinte resposta à nossa chamada de 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 nosso último caso de uso, vamos tentar armazenar um modelo emitindo uma solicitação POST via Templates API:

                                

                                    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"
                                
                            

Nesta solicitação, o parâmetro name indica o nome do modelo. Isso é usado para fazer referência ao modelo em outras chamadas de API. O parâmetro tag identifica a versão específica deste modelo. O parâmetro template especifica o próprio conteúdo do modelo. Aqui, você pode colar o conteúdo em HTML do modelo diretamente na solicitação.

Devemos receber a seguinte resposta:

                                

                                    {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}
                                
                            

As APIs de e-mail ajudam na entregabilidade de e-mail ao facilitar o envio de mensagens para os remetentes e os destinatários. Uma API garante que uma mensagem seja enviada a um público predeterminado (geralmente por meio de uma lista criada pelo remetente) e elimina a necessidade de um grande número de mensagens demoradas e geradas manualmente.

A redução do envio manual também garante menos erros humanos, como endereços de e-mail digitados incorretamente ou e-mails que não são enviados no momento necessário. Isso melhora a precisão e a consistência das mensagens de e-mail enviadas e leva a níveis mais fortes de engajamento com o público-alvo.

O papel das APIs na melhoria da entregabilidade e do engajamento é particularmente importante para organizações que se comunicam com públicos muito grandes. Se 100 clientes solicitarem a redefinição de senha da conta de uma empresa no período de uma hora, essa demanda seria quase impossível de atender caso a empresa tentasse criar 100 e-mails manualmente para a sua clientela (lembre-se do episódio da fábrica de chocolates de I Love Lucy).

Nem sempre é fácil entender as APIs, mas elas tornam seu programa de e-mail mais confiável e eficiente. Quer mais informações sobre como as APIs de e-mail do Mailgun podem ajudar? Confira nossas Documentação da API ou fale com especialistas em entregabilidade da nossa equipe.

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.