API de envio SMTP
Configure o IAGENTEsmtp em sua aplicação e, em menos de 5 minutos, envie e-mails diretamente de sua plataforma.
Para conectar em seu servidor SMTP utilize as informações abaixo. Todos os emails devem ser enviados utilizando UTF-8.
| host | smart.iagentesmtp.com.br |
| usuario | seu usuário de acesso no sistema |
| senha | sua senha de acesso SMTP |
| porta | 25 ou 587 |
| Parâmetro | Descrição |
|---|---|
| x-campanhaid | Especifica um identificador vinculado a seu email (nome de campanha ou id interno) |
As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.
| POST | api.iagentesmtp.com.br/api/v3/send/ |
{
"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"
}
}
{
"status": "ok",
"message": "2 recipient(s)",
"size": "2KB"
}
{
"status": "failed",
"message": "invalid json format"
}
As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.
| POST | api.iagentesmtp.com.br/api/v3/send/ |
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"
}
{
"status": "ok",
"message": "2 recipient(s),"
"size": "2KB"
}
{
"status": "failed",
"message": "invalid json format"
}
As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.
| POST | api.iagentesmtp.com.br/api/v3/send/ |
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=="
}]
}
{
"status": "ok",
"message": "1 recipient(s)",
"attachments": 3,
"size": "1MB"
}
{
"status": "failed",
"message": "invalid json format"
}
As requisições devem ser realizadas para o endereço abaixo em UTF-8 e o conteúdo em formato JSON.
| POST | api.iagentesmtp.com.br/api/v3/send/ |
{
"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}}"
}
{
"status": "ok",
"message": "2 recipient(s)",
"size": "2KB"
}
{
"status": "failed",
"message": "invalid json format"
}
Consulte histórico de atividades registradas por um endereço de e-mail destinatário (30 dias ou 50 registros).
| POST | api.iagentesmtp.com.br/api/v3/activity/ |
{
"api_user": "seu@usuario.com.br",
"api_key" : "******************",
"email" : "email1@destino.com.br"
}
{
"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": ""
}
]
}
Consulte os volumes de e-mails enviados e rejeitados
| POST | api.iagentesmtp.com.br/api/v3/traffic/ |
{
"api_user": "seu@usuario.com.br",
"api_key" : "******************",
}
{
"status": "ok",
"message": "traffic available",
"records": 2,
"traffic":
[
{
"period": "2020-02",
"sent": "31",
"bounces": "0"
},
{
"period": "2020-01",
"sent": "13",
"bounces": "0"
}
]
}
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).
Se o registro já existir, adicione "include:_spf.localservices.com.br" antes do final, conforme exemplo:
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 |
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).
| 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 |
| Endereço de email | |
| Tipo | Tipo do evento (ver tabela abaixo) |
| Descricao | Detalhes do evento |
| Assunto | Assunto do email |
| Log | Recibo de entrega ou rejeição retornado pelo provedor |
| Evento | Descrição |
|---|---|
| enviado | Confirmando que o e-mail foi processado. |
| entregue | E-mail entregue no provedor destino (somente para IP dedicado). |
| falha | E-mail não foi enviado. |
| bounce | E-mail rejeitado no provedor destino. |
| leitura | E-mail foi visualizado (imagens contidas na mensagem foram exibidas). |
| clique | E-mail foi clicado. |
| cancelamento | Destinatário solicitou cancelamento ou reportou lixo eletrônico |