Introdução à API transacional

A API transacional do Flexmail permite enviar e-mails acionados de um para um a partir da aplicação — confirmações de encomenda, reposições de palavra-passe, faturas e tudo o resto que é disparado em resposta a uma ação específica do utilizador. Pode enviar via HTTP (API REST) ou SMTP, usando a mesma conta e credenciais para ambos.

O produto transacional funciona independentemente do produto de marketing do Flexmail. Pode usá-lo sozinho sem configurar campanhas ou listas de contactos.

Atenção A API transacional suporta apenas um destinatário por mensagem. Não pode ser usada para envios em massa ou de marketing. Consulte "E-mail de marketing vs. e-mail transacional" para a explicação completa.

Pré-requisitos

  • Uma conta do Flexmail. Precisa de uma para usar a API transacional, mesmo que esteja apenas a enviar e-mail transacional e não a usar as funcionalidades de marketing.
  • Acesso às definições DNS do domínio para configurar a autenticação de e-mail.
  • Acesso de programador à aplicação ou sistema de envio para integrar a API ou configurar o SMTP.

Passo 1: Ativar o produto transacional

Se já tem uma conta do Flexmail, ative o produto transacional a partir do widget do painel de controlo. O teste gratuito dá-lhe até 1.000 envios durante 30 dias sem custo. Pode atualizar para uma subscrição transacional paga em qualquer momento durante ou após o teste.

Se ainda não tem uma conta, registe-se em flexmail.be/en/signup. As subscrições de marketing e transacional são geridas a partir da mesma conta.

Atenção Não precisa de uma subscrição de marketing para usar o produto transacional. Se apenas pretende enviar e-mail transacional, pode ativar o produto transacional e deixar as funcionalidades de marketing sem uso.

Passo 2: Verificar o endereço de remetente

Antes de poder enviar, precisa de verificar o endereço de e-mail que usará no campo De.

  1. Aceda a Definições, depois a Adicionar ou remover remetentes.
  2. Adicione o endereço de e-mail a partir do qual pretende enviar.
  3. O Flexmail envia um e-mail de verificação para esse endereço — clique na ligação para confirmar. Isto prova que é proprietário da caixa de correio a partir da qual está a enviar.

Screenshot of validation email

Passo 3: Configurar a autenticação de e-mail

Configure SPF, DKIM, DMARC e um caminho de retorno personalizado para o domínio do endereço de remetente. Estes registos DNS provam que os e-mails genuinamente vêm de si — é assim que os fornecedores de caixa de entrada como o Gmail decidem se entregam o e-mail na caixa de entrada ou o rejeitam.

As instruções detalhadas de configuração DNS estão na documentação da API de E-mail do Flexmail, na secção de autenticação de e-mail.

Atenção A autenticação de e-mail não é opcional para e-mail transacional. Sem registos SPF e DKIM corretamente configurados, os e-mails transacionais falharão nas verificações de autenticação nos principais fornecedores de caixa de entrada e podem ser rejeitados ou enviados para spam.

Passo 4: Criar um token de acesso pessoal

A API transacional usa autenticação HTTP Básica. O ID da conta é o nome de utilizador; um token de acesso pessoal é a palavra-passe. Estas credenciais são apenas para a API HTTP — o SMTP usa credenciais separadas fornecidas pelo Flexmail mediante pedido.

  1. Aceda a Definições, depois a API, depois a Tokens de acesso pessoal.
  2. Clique em Criar novo token e dê-lhe um nome descritivo.
  3. Copie o token e guarde-o de forma segura. Não será mostrado novamente.

Passo 5: Escolher o método de envio

O Flexmail suporta duas formas de enviar e-mail transacional. Ambas usam o mesmo ID de conta e token de acesso pessoal.

API HTTP

A API REST dá-lhe o máximo controlo. Pode enviar mensagens, gerir modelos, tratar webhooks e recuperar dados de entrega programaticamente. Esta é a abordagem recomendada para integrações e aplicações personalizadas.

A documentação completa está em email-api.flexmail.eu/documentation. A secção Introdução inclui um exemplo curl que pode executar imediatamente para verificar a configuração.

SMTP

As submissões SMTP estão incluídas no produto transacional sem custo adicional. Use o SMTP quando a aplicação ou plataforma já o suporta — por exemplo, um CMS, uma plataforma de e-commerce ou um sistema legado que envia e-mail através de um relay SMTP.

Consulte "Submissões SMTP para e-mail transacional" para as definições de ligação e instruções de configuração.

Passo 6: Integrar na aplicação

Com um envio de teste bem-sucedido confirmado, está pronto para integrar a API na aplicação. A documentação completa cobre:

  • Envio de mensagens: todos os parâmetros para o endpoint de envio
  • Modelos — criar e referenciar modelos de e-mail reutilizáveis. Consulte "Modelos transacionais e personalização" para uma visão geral prática.
  • Webhooks — notificações de eventos em tempo real para envios, entregas, bounces, aberturas e cliques. Consulte "Webhooks transacionais" para configuração e referência de eventos.

Dica de suporte Configure o tratamento de webhooks cedo na integração. Saber quando um e-mail transacional tem bounce permite agir imediatamente — marcar o endereço no sistema, acionar uma notificação de seguimento ou alertar a equipa — em vez de descobrir um problema de entrega dias depois.

Documentação da API e suporte

A documentação completa da API está disponível em email-api.flexmail.eu/documentation.

Se ficar preso em qualquer ponto, a equipa de suporte do Flexmail está disponível em support@flexmail.eu. As questões sobre a API transacional são tratadas pela mesma equipa que suporta a interface de marketing.

Próximos passos

Artigos relacionados

Há mais que pode fazer no Flexmail

À procura de informação de contexto?

Inspire-se!

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.