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)

Envio de e-mail individual

Requisição para envio simples

As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.

POST app1.iagentesmtp.com.br/api/v3/send/

Exemplo de requisição para envio simples

{

"api_user": “seu@usuario.com.br”,

"api_key" : "******************",

"to":

[{

"email": "email@destino.com.br",

"name" : "Fulano"

}]

,

"from":

{

"name": "João",

"email": "email@remetente.com.br",

"reply_to": "email@remetente.com.br"

}

,

"subject": "Assunto de seu envio",

"html": "Olá mundo",

"text": "Olá mundo"

"campanhaid": "seu identificaor interno, opcional",

"addheaders":

{

"x-priority" : "1"

}

}

Exemplo de resposta em caso de sucesso.

{

"status": "ok",

"message": "2 recipient(s)"

}

Exemplo de resposta em caso de erro.

{

"status": "failed",

"message": "invalid json format"

}

Envio de e-mail para múltiplos destinatários

Requisição de envio para múltiplos destinatários

As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.

POST app1.iagentesmtp.com.br/api/v3/send/

Exemplo de requisição para múltiplos destinatários

Limite máximo de 500 destinatários por requisição

{

"api_user": “seu@usuario.com.br",

"api_key" : "******************",

"to":

[{

"email": "email1@destino.com.br",

"name" : "Fulano1"

},

{

"email": "email2@destino.com.br",

"name" : "Fulano2"

},

{

"email": "email3@destino.com.br",

"name" : "Fulano3"

}]

,

"from":

{

"name": "João",

"email": "email@remetente.com.br",

"reply_to": "email@remetente.com.br"

}

,

"subject": "Assunto de seu envio",

"html": "Olá mundo",

"text": "Olá mundo"

}

Exemplo de resposta em caso de sucesso.

{

"status": "ok",

"message": "2 recipient(s)"

}

Exemplo de resposta em caso de erro.

{

"status": "failed",

"message": "invalid json format"

}

Envio de e-mail com anexo

Requisição de envio com Anexo

As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.

POST app1.iagentesmtp.com.br/api/v3/send/

Exemplo de requisição com anexo

Conteúdo do anexo em base64

{

"api_user": “seu@usuario.com.br",

"api_key" : "******************",

"to":

[{

"email": "email@destino.com.br",

"name" : "Fulano"

}]

,

"from":

{

"name": "João",

"email": "email@remetente.com.br",

"reply_to": "email@remetente.com.br"

}

,

"subject": "Assunto de seu envio",

"html": "Olá mundo",

"text": "Olá mundo"

"attachments":

[{

"filename": "teste.txt",

"type" : "text/plain"

"content" : "QXJxdWl2byBkZSB0ZXN0ZQ=="

}]

}

Exemplo de resposta em caso de sucesso.

{

"status": "ok",

"message": "1 recipient(s)"

}

Exemplo de resposta em caso de erro.

{

"status": "failed",

"message": "invalid json format"

}

Envio de e-mail com conteúdo personalizado

Requisição de envio com personalização de conteúdo

As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.

POST app1.iagentesmtp.com.br/api/v3/send/

Exemplo de requisição com personalização de conteúdo

{

"api_user": “seu@usuario.com.br",

"api_key" : "******************",

"to":

[{

"email": "email1@destino.com.br",

"name" : "Fulano1",

"custom":

{

"nome": "Fulano1",

"empresa": "IAGENTESMTP"

}

},

{

"email": "email2@destino.com.br",

"name" : "Fulano2",

"custom":

{

"nome": "Fulano2",

"empresa": "IAGENTESMTP"

}

}]

,

"from":

{

"name": "João",

"email": "email@remetente.com.br",

"reply_to": "email@remetente.com.br"

}

,

"subject": "Assunto de seu envio",

"html": "Olá {{nome}} você trabalha na empresa {{empresa}}",

"text": "Olá {{nome}} você trabalha na empresa {{empresa}}"

}

Exemplo de resposta em caso de sucesso.

{

"status": "ok",

"message": "2 recipient(s)"

}

Exemplo de resposta em caso de erro.

{

"status": "failed",

"message": "invalid json format"

}

Histórico de um endereço de e-mail

Histórico de um endereço de e-mail

Consulte histórico de atividades registradas por um endereço de e-mail destinatário (30 dias ou 50 registros).

POST app1.iagentesmtp.com.br/api/v3/activity/

Exemplo de requisição para consultar

{

"api_user": “seu@usuario.com.br",

"api_key" : "******************",

"email" : "email1@destino.com.br"

}

Resposta em caso de sucesso

{

"status": "ok",

"message": "history available",

"records": 2,

"email": "email1@destino.com.br",

"events":

[

{

"Date": "2019-10-28 10:50:45",

"sender": "suporte@iagente.com.br",

"subject": "Envio de teste IAGENTESMTP - 28\/10\/2019 10:50:30",

"recipient": "teste@iagente.com.br",

"event": "leitura",

"description": ""

},

{

"Date": "2019-10-28 10:50:30",

"sender": "suporte@iagente.com.br",

"subject": "Envio de teste IAGENTESMTP - 28\/10\/2019 10:50:30",

"recipient": "teste@iagente.com.br",

"event": "enviado",

"description": ""

}

]

}

Histórico de consumo mensal

Histórico de consumo mensal

Consulte os volumes de e-mails enviados e rejeitados

POST app1.iagentesmtp.com.br/api/v3/traffic/

Exemplo de requisição para consultar

{

"api_user": “seu@usuario.com.br",

"api_key" : "******************",

}

Resposta em caso de sucesso

{

"status": "ok",

"message": "traffic available",

"records": 2,

"traffic":

[

{

"period": "2020-02",

"sent": "31",

"bounces": "0"

},

{

"period": "2020-01",

"sent": "13",

"bounces": "0"

}

]

}

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