Product
Torne-se especialista em e-mails com nossa API de modelos
Modelos de e-mail são o segredo para produzir campanhas de e-mail consistentes e escalonáveis.
No Mailgun, disponibilizamos diversos modelos de e-mail responsivos em nossa interface de usuário. Esses arquivos HTML contêm blocos de código modulares que definem o visual e o estilo dos seus e-mails.
Também publicamos modelos de código aberto no GitHub para suprir suas necessidades diárias de e-mail. Tudo o que você precisa fazer é adicionar o conteúdo do e-mail.
Mas e se você já tiver um modelo ou precisar de mais personalização além dos nossos designs prontos para uso? Agora, você pode usar a nossa API de modelos para trazer seus próprios modelos de e-mail para a sua conta do Mailgun.
Abaixo, explicaremos onde encontrar um modelo de e-mail, como enviá-lo para o Mailgun usando a API de modelos e algumas práticas recomendadas.
Quais são os benefícios dos modelos de e-mail?
Modelos de e-mail são arquivos HTML que contêm código reutilizável para facilitar a criação de campanhas de e-mail. Em vez de escrever e testar novos códigos a cada envio, basta recortar e colar textos, URLs de imagens e links em um modelo existente para produzir uma nova campanha.
Os principais benefícios incluem:
- Eficiência: não perca tempo reinventando a roda. Basta colar o conteúdo do seu e-mail no modelo e pronto.
- Consistência: mantenha um visual alinhado à sua marca em todos os e-mails usando o mesmo código.
- Escalabilidade: permita que pessoas sem conhecimento técnico criem campanhas de e-mail, diminuindo a dependência da equipe de desenvolvimento para montar as campanhas uma a uma.
Em resumo, os modelos de e-mail fazem o trabalho pesado na hora de criar formatos de e-mail para as suas campanhas.
Quais são os tipos de modelos de e-mail?
Mas existem tantos modelos disponíveis – como saber qual é o ideal? Abaixo, identificamos três tipos principais de modelos de e-mail com uma breve descrição das necessidades que eles atendem:
- Disparos de e-mail são campanhas de marketing pontuais enviadas para grande parte da sua base de usuários.
- E-mails transacionais são mensagens disparadas por ações do usuário no seu site, como criar uma conta, fazer uma compra ou solicitar uma nova senha.
- Newsletters por e-mail são conversas recorrentes entre a sua marca e seus assinantes. Envie e-mails como esses para manter o engajamento da sua base de usuários.
Onde encontro modelos de e-mail?
Caso não queira enviar seus próprios modelos de e-mail, veja uma lista com modelos gratuitos do Mailgun:
- Escolha entre seis modelos prontos em nossa interface de usuário.
- Faça o fork modelos de e-mail transacional do nosso repositório no Github.
- Confira os modelos HTML gratuitos no Email on Acid.
Você pode usar nossos modelos como estão ou usá-los de inspiração para criar um novo modelo. Em seguida, envie-os para a sua conta do Mailgun por meio da API de modelos.
Como faço para começar a usar a API de modelos?
Antes de enviar o seu modelo de e-mail, você precisará de uma conta do Mailgun e de um domínio verificado em nosso sistema. Além disso, observe que, no momento, oferecemos suporte apenas ao Handlebars mecanismo de modelos, que é uma escolha popular no design de e-mail.
Abaixo, explicaremos duas formas de armazenar e inicializar um modelo. Em seguida, falaremos sobre o controle de versão dos modelos e sobre o envio de e-mails de teste para verificar se o modelo foi armazenado corretamente.
Nossa API de modelos faz parte da poderosa API de e-mail do Mailgun. Você pode acessar nossa API de modelos no seguinte endpoint: /templates. Confira nossas documentação de referência da API de modelos para obter informações mais detalhadas.
Como faço para armazenar um modelo e inicializá-lo ao mesmo tempo?
Vamos começar armazenando o seu modelo na sua conta do Mailgun.
Primeiro, vamos tentar armazenar um modelo com uma versão ativa inicial enviando uma solicitação POST para o endpoint da API de modelos. Isso armazena os metadados do modelo e também o seu conteúdo.
curl -X POST https://api.mailgun.net/v3/example.com/templates
-F name="billing"
-F description="template description" -F tag="v0"
-F template=”template contents”
Nesta solicitação, os parâmetros name, tag e template são obrigatórios. O parâmetro name indica o nome do modelo e é usado para consultá-lo em outras chamadas de API. O parâmetro tag identifica a versão específica deste modelo. O controle de versão é benéfico nas campanhas de e-mail, o que discutiremos mais adiante. 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.
Mas e se o modelo estiver armazenado no seu disco local? A solicitação de exemplo abaixo mostra como extrair o conteúdo do modelo a partir de um arquivo. Para este exemplo, vamos considerar que o seu modelo foi salvo localmente como billing.html.
curl -X POST https://api.mailgun.net/v3/example.com/templates
-F name="billing"
-F description="template description" -F tag="v0"
-F template=<code data-enlighter-language="generic" class="EnlighterJSRAW">content from file billing.html</code>
Assim como no primeiro exemplo, isso exige os parâmetros name, template e tag.
Como faço para armazenar um modelo e inicializá-lo separadamente?
Como alternativa, você pode armazenar um modelo em duas etapas:
- Armazene os metadados de um modelo.
- Armazene uma versão do modelo.
Ao armazenar um modelo sem usar o parâmetro tag para adicionar um número de versão ou o parâmetro template para fornecer o conteúdo do modelo, você registra os metadados do modelo na sua conta do Mailgun. O seu modelo não fica ativo neste momento, mas é armazenado para uso posterior.
Para ativar o seu modelo, você precisará atualizar os metadados armazenados fornecendo o conteúdo do modelo em outra solicitação. Isso criará a primeira versão, v0, do seu modelo.
Armazenar metadados de um modelo
Use a solicitação a seguir para armazenar os metadados de um modelo sem inicializá-lo.
curl -X POST https://api.mailgun.net/v3/example.com/templates
-F name="billing"
-F description = "description of your template"
O parâmetro name é obrigatório.
Armazenar uma versão do modelo
Use a seguinte solicitação para armazenar a versão de um modelo após criar um registro dos seus metadados. Mais uma vez, vamos considerar que o conteúdo do modelo está armazenado no seu disco local como billing.html. Usamos Python no exemplo a seguir.
import requests
content = None
with open("/path_to_file/billing.html", 'r') as f:
content = f.read()
requests.post("https://api/mailgiun.net/v3/example.com/templates/billing/versions",
auth=('api': "key"),
data={"tag": "v0",
"comment": "version comment",
"template": content})
O seu modelo agora está ativo, já que você forneceu o conteúdo e o número da versão.
Por que preciso criar versões de um modelo?
Para que o seu modelo fique ativo, ele precisa ter pelo menos uma versão. A versão inicial é chamada de “v0” no parâmetro tag dos exemplos acima. Mas, em alguns casos, é útil ter várias versões de um modelo.
Por exemplo, você pode usar diversas versões para:
- Fornecer informações ou atualizações de produtos.
- Realizar pesquisas de experiência de uso em textos, elementos de design ou chamadas para ação.
- Adaptar e-mails para atender às necessidades dinâmicas da campanha.
Lembre-se de que é necessário ter sempre uma versão ativa de um modelo. Os e-mails usarão esta versão ativa, a menos que especificado de outra forma. Por padrão, a versão ativa é a primeira que você armazena ao fazer o upload do modelo.
Conforme mostrado abaixo, é possível atualizar a versão ativa para uma nova versão com uma simples solicitação PUT usando o endpoint da API de modelos. Para este exemplo, vamos considerar que existem duas versões do seu modelo, v0 e v1, e que a v0 está ativa.
Mas e quanto ao envio?
Agora que adicionamos o modelo à sua conta, usaremos a API de mensagens do Mailgun para enviar um e-mail de teste. Poderíamos apenas renderizar a mensagem, mas enviar uma mensagem de teste permite ver se a sua informação variável está funcionando como esperado. Lembre-se de que é preciso anexar os seus dados corretamente para que as informações variáveis funcionem. A forma de fazer isso depende de se você está enviando via SMTP ou API.
Vamos enviar uma mensagem de teste com uma solicitação POST usando as variáveis de destinatários num objeto JSON. Usaremos a API de mensagens do Mailgun para fazer isso.
curl -X POST https://api.mailgun.net/v3/example.com/messages
-F template="billing"
-H "X-Mailgun-Variables: {"firstName": "John",
"lastName": "Doe",
"number": "12345",
"data":"Mar 01, 2019",
"amount1": "23.00",
"amount2": "10.20",
"total": "33.20"}"
Se os dados foram anexados de forma correta, o e-mail de teste deve corresponder à renderização com as variáveis no lugar certo.
Como faço para enviar uma versão específica de um modelo?
Já falamos sobre como criar várias versões de um modelo de e-mail pode turbinar a sua campanha. Mas como se envia uma versão específica de um modelo?
Por padrão, os e-mails usam a versão ativa do modelo. Entretanto, é bem simples configurar o e-mail para enviar uma versão específica que não está ativa. Use as seguintes flags na sua chamada de API: t:version e t:text.
curl -X POST https://api.mailgun.net/v3/example.com/messages
-F template="billing"
-F t:version="v1"
-F t:text="yes"
A flag t:version indica qual versão do seu modelo deve ser usada. Para o par chave-valor t:text , passe yes para renderizar o seu modelo na parte de texto do e-mail.
Conclusão
Simples assim! Armazenamos nosso modelo na conta do Mailgun com êxito, testamos o controle de versão e enviamos e-mails de teste. Consulte nossa documentação para aproveitar ao máximo a API de modelos.
Se enfrentar qualquer problema com seus modelos, envie-nos um ticket de suporte! Entraremos em contato o mais breve possível.
A criatividade está em alta? Envie-nos os designs do seu modelo! Leia mais sobre isso em nosso artigo do blog.
