Para realizar o cadastro de uma e-mail é necessário apenas as credenciais da conta que deseja cadastrar.
POST
A solicitação é feita através de uma requisição POST. A rota chamada deve ter a seguinte URL:
Homologação:
https://homologacao.plugboleto.com.br/api/v1/email/config
Produção:
https://plugboleto.com.br/api/v1/email/config
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| cnpj-sh | CNPJ da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Objeto
| Campo | Tipo | Valores aceitos | Descrição |
| servico | String |
"Padrão": o email genérico da Tecnospeed será utilizado para os envios; "Personaliado": Os emails serão enviados de acordo com as informações do provedor cadastradas; "Gmail"; "Hotmail"; "Terra"; "Uol"; "Yahoo" |
Tipo do serviço que deseja ultilizar |
| emailremetente | String | Campo destinado para informar o endereço de e-mail a ser cadastrado | |
| usuario | String | Campo destinado para informar o login da conta de e-mail | |
| senha | String | Senha da conta de e-mail | |
| config | Objeto | Objeto contendo as configurações do serviço personalizada, Usado apenas com serviço personalizado | |
| smtp | String | Endereço SMTP de sua provedora de e-mail, Usado apenas com serviço personalizado | |
| port | String | Porta SMTP de sua provedora de e-mail, Usado apenas com serviço personalizado | |
| requiretls | Boolean | Campo destinado para informar se sua conta utiliza TLS, Usado apenas com serviço personalizado, campo opcional |
Body
Exemplo de JSON:
Essa rota recebe no (body) da requisição o serviço de e-mail, junto com suas respectivas configurações, o serviço pode ser preenchido com os seguintes serviços que atendemos
Nesse exemplo está sendo cadastrado um e-mail, usando um serviço de SMTP personalizado.
{
"servico": "personalizado",
"usuario": "email@teste.com.br",
"emailremetente": "email@teste.com.br",
"senha":"123457",
"config":{
"smtp":"smtp.teste.io",
"port":"2525",
"requiretls":false
}
}
O campo config, é apenas necessário para SMTPs personalizados, serviços como Gmail, Outlook, UOL, Terra, Yahoo, as configurações são preenchidas automaticamente no ato de cadastro como pode se ver logo abaixo
{
"servico": "Gmail",
"usuario": "email@gmail.com.br",
"emailremetente": "email@gmail.com.br",
"senha":"senha"
}
Retorno
Exemplo de retorno:
{
_status: 'sucesso',
_mensagem: 'Configurações de e-mail salvas com sucesso.'
}
Exemplo de retorno com erro:
{
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "senha",
"_erro": "Campo obrigatório."
},
{
"_campo": "usuario",
"_erro": "Campo obrigatório."
},
{
"_campo": "emailremetente",
"_erro": "Campo obrigatório."
}
]
}
}
Com o e-mail cadastrado, é possível enviar boletos por e-mail com o seu endereço de e-mail.
Comentários
0 comentário
Por favor, entre para comentar.