0% acharam este documento útil (0 voto)
11 visualizações3 páginas

API HTTP SMTP

Este guia fornece informações sobre a API de envio SMTP, incluindo o endpoint e os parâmetros necessários para realizar envios de e-mail. Os parâmetros obrigatórios incluem informações de autenticação e detalhes do remetente e destinatário. O documento também apresenta exemplos de chamadas HTTP e possíveis respostas da API, incluindo status de sucesso e erros.

Enviado por

João Loureiro
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
0% acharam este documento útil (0 voto)
11 visualizações3 páginas

API HTTP SMTP

Este guia fornece informações sobre a API de envio SMTP, incluindo o endpoint e os parâmetros necessários para realizar envios de e-mail. Os parâmetros obrigatórios incluem informações de autenticação e detalhes do remetente e destinatário. O documento também apresenta exemplos de chamadas HTTP e possíveis respostas da API, incluindo status de sucesso e erros.

Enviado por

João Loureiro
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd

API de envio de email em HTTP

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 realizar os
envios através de nosso SMTP dedicado.

A primeira coisa que você deve saber é o endpoint que usamos:

https://painel.mailgrid.com.br/api-http/

OBS: Também é possível usar o protocolo http caso prefira.

Objeto status

Ao realizar um envio, este será o objeto que você irá receber como
resposta. Todos os envios são realizados na API pela porta 587
SMTP.

OBS: Assunto e mensagem devem ser codificados em UTF-8.


Parâmetros a serem enviados

Os parâmetros devem ser passados via GET ou POST.

Parametro Valor Obs.


host_smtp endereço do servidor smtp Obrigatório

usuario_smtp usuário para autenticação Obrigatório

senha_smtp senha para autenticação Obrigatório

emailRemetente e-mail do remetente Obrigatório

nomeRemetente nome do remetente Opcional

emailDestino e-mail para onde será Obrigatório - pode ser


enviada a mensagem único ou array com
múltiplos endereços
nomeDestino nome do destinatário Opcional

assunto assunto da mensagem Obrigatório

mensagem mensagem a ser enviada Obrigatório – texto ou


html

Exemplo de chamada HTTP usando GET:

https://www.mailgrid.com.br/cliente/api-http/?
host_smtp=serverXX.mailgrid.com.br&[email protected]&se
nha_smtp=XXXXXX&[email protected]&nomeRemetente
=NOME&[email protected]&assunto=Teste de
mensagem&mensagem=teste de mensagem por api
Exemplo de retorno da API:

Quando a mensagem for enviada:

STATUS: OK - ID f87e7bf77c609d9537e146fb32d88418

Quando ocorrer erro no envio, informará o erro de SMTP:

SMTP -> ERROR: Password not accepted from server: 535 Incorrect
authentication data

Caso a API retorne o erro:

STATUS: ERRO - FALTAM PARAMETROS

Isso quer dizer que um ou mais parâmetros não foram passados.

As mensagens enviadas com sucesso são registradas automaticamente no relatório


de envios.

_________________________________________________________________________________

Você também pode gostar