API de envio SMTP

Configure o IAGENTEsmtp em sua aplicação e, em menos de 5 minutos, inicie as cadências de envios de 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.

Documentação

Integre o IAGENTEsmtp à sua plataforma, ERP ou sistema e envie e-mails de acordo com a rotina de comunicação de sua empresa, gerencie grupo/contatos e acesse relatórios completos.

SMTP

API HTTP

INBOUND MAIL

Conectando no SMTP

Conecte sua plataforma, ERP ou sistema ao IAGENTEsmtp utilizando as informações abaixo. Importante: Todos os emails devem ser enviados utilizando UTF-8.

Host
smart.iagentesmtp.com.br
Usuário
seu usuário de acesso no sistema
Senha

senha smtp

Porta
25 ou 587
  • * Limite de 30MB para cada e-mail enviado, incluindo cabeçalhos e anexos;
  • * Limite de 500 destinatários para cada e-mail enviado;
  • * Limite de 50 conexões simultâneas;
  • * Opção "com cópia (CC)" será transformada em um e-mail avulso;
  • * Opção "com cópia oculta (BCC) não é suportada.

Parâmetros adicionais no cabeçalho
dos e-mails enviados

Parâmetro

Descrição

x-campanhaid

Especifica um identificador vinculado a seu e-mail (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
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 identificador interno, opcional",
  "addheaders": {
    "x-priority": "1"
  }
}

Exemplo de resposta em caso de sucesso. 

{
  "status": "ok",
  "message": "2 recipient(s)",
  "size": "2KB"
}

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
api.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)",
  "size": "2KB"
}

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
api.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)",
  "attachments": 3,
  "size": "1MB"
}

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
api.iagentesmtp.com.br/api/v3/send/

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

Exemplo de resposta em caso de sucesso. 

{
  "status": "ok",
  "message": "2 recipient(s)",
  "size": "2KB"
}
{
  "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 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
api.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"
}

Exemplo de 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
api.iagentesmtp.com.br/api/v3/traffic/

Exemplo de requisição para consultar 

{
  "api_user": "seu@usuario.com.br",
  "api_key": "******************",
}

Exemplo de 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/12/2015+12:23:33&
CampanhaID=1234&
Email=email@email.com.br&
Assunto=Asunto+do+envio&
Tipo=bounce&
Descricao=endereco+inexistente&
Log=smtp%3B%20550%205.1.1%20User%20Unknown

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
Log
Recibo de entrega ou rejeição retornado pelo provedor

Tipo de notificações

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

Inbound mail - Recebendo e-mails

Receba as respostas dos e-mails de seus usuários diretamente em sua aplicação. Configure seu domínio para que possamos receber e processar os e-mails de resposta de seus usuários e enviar através de webhooks direto para sua aplicação. Você pode configurar quantos domínios quiser e utilizar quantas caixas postais desejar. Os dados serão enviados no formato JSON conforme abaixo

{
  "info": {
    "date": "2020-09-27 14:57:21",
    "sender_info": "100.100.000.0",
    "size": "46139",
    "domain": "inbox.seudominio.com.br",
    "inbox": "mark",
    "id": "12345617304857771330"
  },
  "from": {
    "name": "John",
    "address": "John@domain.com.br"
  },
  "original_to": "mark@inbound.seudominio.com.br",
  "subject": "Esse e-mail é um teste",
  "to": [
    {
      "address": "mark@inbound.seudominio.com.br",
      "name": "Mark"
    }
  ],
  "cc": [
    {
      "address": "sales@domain.com.br",
      "name": "Sales"
    }
  ],
  "body": {
    "html": "versão html...",
    "text": "versão texto..."
  },
  "attachments": [
    {
      "filename": "image.jpeg",
      "encoding": "base64",
      "type": "image\/jpeg",
      "disposition": "inline",
      "content": "QEBAQEBAQEBAQEBAQEBAQEBAQEBAQ..."
    }
  ],
  "headers": {
    "received": [
      "from ...",
      "by ..."
    ],
    "date": "...",
    "from": "...",
    "subject": "...",
    "to": "..."
  }
}

Política de Privacidade

Instagram Facebook-square Linkedin-in Youtube Twitter

E-mail transacional

E-mail marketing

SMS

Assine nossa newsletter