API de envio SMTP

spacer
Configure o IAGENTEsmtp em sua aplicação e, em menos de 5 minutos, envie e-mails diretamente de sua plataforma.

Apresentação

Se você possui uma aplicação, site ou qualquer serviço online, certamente possui algum processo automatizado que necessita do envio de e-mails, correto? Envio de cobranças, avisos e até mesmo comunicados simples aos seus clientes. Então: conheça o IAGENTEsmtp: plataforma para agilizar seu tráfego de envios de e-mails e análise de resultados.

Conectando no SMTP

Para conectar em seu servidor SMTP utilize as informações abaixo. Todos os emails devem ser enviados utilizando UTF-8.

host smtp1.iagentesmtp.com.br
usuario seu usuário de acesso no sistema
senha sua senha de acesso no sistema
porta 25 ou 587
  • * Limite de 2MB por cada mensagem enviada, incluindo cabeçalhos e anexos;
  • * Limite de 500 destinatários para cada mensagem enviada;
  • * Limite de 15 conexões simultâneas;
  • * Limite de 500 conexões por minuto;
  • * CC serão transformados em emails avulsos;
  • * BCC não serão enviados;

Parâmetros adicionais no cabeçalho dos emails enviados

Parâmetro Descrição
x-campanhaid Especifica um identificador vinculado a seu email (nome de campanha ou id interno)
x-trackingdomain Ativa o monitoramento de cliques e leituras utilizando o domínio especificado. O domínio deve estar com regra de CNAME configurado.

Enviando por HTTP - POST

Sua chave para autenticação HTTP.

CHAVE sua chave

As requisições devem ser realizadas para o endereço abaixo em UTF-8 e os valores dos parametros URLENCODED.

POST iagentesmtp.com.br/api/v1/send.json (ou .xml)
DATA
api_user=seu_login&
api_key=sua_chave&
from=remetente@exemplo.com.br&
fromname=Nome_Remetente&
to=destinatario@exemplo.com.br&
toname=Nome_Destinatario&
subject=Assunto_Teste&
html=codigo_html

Resposta JSON em caso de sucesso.

{
"status": "OK",
"message": "1 mensagens processadas"
}

Resposta XML em caso de erro.

{
"status": "ERRO",
"message": "Falha autenticacao"
}

Resposta XML em caso de sucesso.

<result> <status>OK</status> <message>1 mensagens processadas</message> </result>

Resposta XML em caso de erro.

<result> <status>ERRO</status> <message>Falha autenticacao</message> </result>

Lista completa de parâmetros

Parâmetro Obrigatório Descrição
api_user sim Login de sua conta
api_key sim Chave de sua conta
from sim Endereço de email do remetente da mensagem
fromname não Nome do remetente da mensagem em formato urlencoded
to sim Endereço de email do destinatário da mensagem. Para múltiplos destinatários veja tabela abaixo.
toname não Nome do destinatário da mensagem em formato urlencoded. Para múltiplos destinatários veja tabela abaixo.
subject sim Assunto de sua mensagem
html não Conteúdo HTML de sua mensagem em formato urlencoded. Se esse parâmetro for vazio o parâmetro "texto" deve ser informado.
text não Conteúdo TEXTO de sua mensagem em formato urlencoded. Se esse parâmetro for vazio o parâmetro "html" deve ser informado.
replyto não Especifica o endereço de resposta a mensagem enviada
campanhaid não Especifica um identificador seu a mensagem
trackingdomain não Especifica o domínio a ser utilizado para captura de leituras, clicks e cancelamentos em suas mensagens.
O domínio informado deve estar com CNAME configurado para funcionar corretamente.

Para enviar emails para múltiplos destinatários utilize os parâmetros "to" e "toname" em forma de array. (máximo 1000 destinatários por requisição)

POST iagentesmtp.com.br/api/v1/send.json (ou .xml)
DATA
api_user=seu_login&
api_key=sua_chave&
from=remetente@exemplo.com.br&
fromname=Nome_Remetente&
to[]=destinatario1@exemplo.com.br&
to[]=destinatario2@exemplo.com.br&
to[]=destinatario3@exemplo.com.br&
toname[]=Nome_Destinatario_1&
toname[]=Nome_Destinatario_2&
toname[]=Nome_Destinatario_3&
subject=Assunto_Teste&
html=codigo_html

Melhorando a entregabilidade (SPF)

Para melhorar a entregabilidade de seus emails é necessário configurar o SPF no DNS de seus domínios (domínios que serão utilizados como remetente das mensagens).

Adicione o seguinte registro TXT no DNS de todos os seus domínios:

v=spf1 a mx include:_spf.localservices.com.br ~all

Se o registro já existir, adicione "include:_spf.localservices.com.br" antes do final, conforme exemplo:

v=spf1 a mx include:_spf.seudominio.com
include:_spf.localservices.com.br ~all

Ativando relatórios de leituras, cliques e cancelamentos (CNAME)

Configurando CNAME

Para ativar os relatórios de cliques e leituras é necessário especificar e configurar um domínio de sua propriedade.

Crie um apontamento do tipo “CNAME" no DNS do domínio, conforme abaixo:

Tipo Host Valor
CNAME app1 iagentesmtp.com.br
  • * Os relatórios só estão disponíveis para emails enviados no formato HTML.
  • * Para ativar o link de descadastramento em seus emails utilize Remover

Enviando notificações para sua aplicação (webhooks)

Para enviar notificações para sua aplicação é necessário informar um URL para onde devemos postar as informações.

Abaixo o exemplo de uma notificação enviada para sua aplicação (GET).

Abaixo o exemplo de uma notificação enviada para sua aplicação (GET).

http://www.seudominio.com.br/seuscript.php?Data=12/23/2015+12:23:33&
CampanhaID=1234&
Email=email@email.com.br&
Assunto=Asunto+do+envio&
Tipo=bounce&
Descricao=endereco+invalido

Parâmetros enviados em uma notificação

Parâmetro Descrição
Data Data e hora em que o evento foi gerado
CampanhaID Retorna o valor informado por você no momento do envio
Email Endereço de email
Tipo Tipo do evento (ver tabela abaixo)
Descricao Detalhes do evento
Assunto Assunto do email

Tipo de notificações

Evento Descrição
bounce Sempre que um email é rejeitado no provedor destino, informando caixa postal cheia, email inexistente etc...
leitura Sempre que um destinatário confirma a leitura de um email enviado (visualizou imagens contidas na mensagem)
clique Sempre que uma url é clicada em um email
cancelamento Sempre que um destinatário solicita não receber mais seus emails

ASSINE NOSSA NEWSLETTER

Rua Açores, nº 68, conjunto 501, Passo D'Areia - Porto Alegre - RS - Brasil - CEP 91030-340
4007.2564 - Capitais e regiões metropolitanas
(51) 3119.2600 - Demais localidades