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 | smtp1.iagentesmtp.com.br |
| usuario | seu usuário de acesso no sistema |
| senha | sua senha de acesso no sistema |
| porta | 25 ou 587 |
| 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. |
| 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 |
| 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 |
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 |
| 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 |