API HTTP para obter relatório de envios
Introdução
Bem-vindo ao guia de referências da API de envio SMTP! É através
desta API que você irá integrar seu sistema ao nosso para obter o
relatório de entrega dos envios realizados através de nosso SMTP
dedicado.
A primeira coisa que você deve saber é o endpoint que usamos:
[Link]
OBS: Também é possível usar o protocolo http caso prefira.
Os parâmetros devem ser passados via GET ou POST.
Parâmetros a serem enviados
Parametro Valor Obs.
usuario_smtp usuário para autenticação – fornecido na Obrigatório
abertura de conta, o mesmo utilizado para
autenticação smtp
senha_smtp senha para autenticação – a mesma senha Obrigatório
utilizada na autenticação smtp
dataini Data de início da consulta – formato aaaa- Obrigatório
mm-dd (ano-mes-dia)
horaini Hora de início da consulta – formato Obrigatório
HH:MM (horas:minutos)
datafim Data de fim da consulta – formato aaaa- Obrigatório
mm-dd (ano-mes-dia)
horafim Hora de fim da consulta – formato HH:MM Obrigatório
(horas:minutos)
status status = status dos envios a serem Opcional
consultados, erro ou sucesso (ex: se passar
status=sucesso o relatório somente
retornará os emails entregues)
emaildestino email para onde a mensagem foi enviada - Opcional
caso queira pesquisar emails enviados
para um determinado destinatário
remetente email utilizado como remetente do envio - Opcional
caso queira pesquisar emails enviados por
um determinado remetente
Exemplo de chamada HTTP usando GET:
[Link]
usuario_smtp=USUARIO&senha_smtp=SENHA&dataini=2018-11-
01&horaini=00:00&datafim=2018-12-
31&horafim=23:59&status=erro&emaildestino=EMAILDESTINO
Exemplo de retorno da API:
Quando os parâmetros forem passados corretamente, a API
retornará os dados dos envios, no período selecionado.
Ex:
1grzDQ-000866-
0o;cobranca@[Link];comercial@[Link];08/11/2018;[Link]
5;Entregue com sucesso
1grzDc-00086s-
9P;cobranca@[Link];cervejaria@[Link];08/11/2018;[Link]
1;Entregue com sucesso
1grzDi-00087c-
PO;cobranca@[Link];fernando@[Link];08/11/2018;[Link]
6;Entregue com sucesso
1grzDi-00087c-
PO;cobranca@[Link];financeiro@[Link];07/11/2018;[Link]
06;Entregue com sucesso
Quando ocorrer erro na informação dos parâmetros, resultará em
mensagem de erro:
ex:
STATUS: ERRO - FALTAM PARAMETROS
Códigos e erros:
STATUS: ERRO - FALTAM PARAMETROS
Isso quer dizer que um ou mais parâmetros obrigatórios, não foram passados.
STATUS: ERRO - FALHA DE AUTENTICACAO
Informa que os dados fornecidos estão incorretos (usuário e senha)
STATUS: ERRO - DATA COM FORMATO INCORRETO - formato deve ser YYYY-
MM-DD
Data fornecida em formato incorreto. Informe a data no formato ANO-MES-
DIA (ex: 2018-12-01)
STATUS: ERRO - HORA COM FORMATO INCORRETO - formato deve ser
HH:MM
Hora fornecida com formato incorreto. Informe a hora no formato solicitado:
HH:MM (horas:minutos) ex: 12:02
Atenção! Os relatórios de envios são atualizados aprox. a cada 15 minutos. Ao
realizar um envio, caso não o veja em seguida no painel, basta aguardar a
atualização.
_________________________________________________________________________________
