Nesse passo vamos realizar o envio de e-mail para o sacado (o mesmo e-mail informado na inclusão do boleto, que fizemos lá atras). Para realizar esse processo, vamos precisar apenas do IdIntegracao para identificar o nosso boleto.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/email/lote
Produção:
https://plugboleto.com.br/api/v1/email/lote
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
Para solicitar a impressão, o objeto JSON pode ter os seguintes campos:
| Campo | Tipo | Descrição |
| IdIntegracao | array | Objeto array com os IdIntegracao dos boletos que serão enviados por e-mail. Os IdIntegracao devem ter a vírgula como separador. |
| EmailNomeRemetente | string | Nome do Remetente do e-mail. Esse nome irá aparecer na caixa de entrada do Sacado. |
| EmailRemetente | string | E-mail do Remetente do e-mail. Caso o Sacado responda o e-mail, o mesmo será enviado para o usuário informado aqui. |
| EmailResponderPara | string | Campo opcional, utilizado caso o endereço de resposta dos emails seja diferente do email do rementente. O funcionamento depende do provedor de email utilizado. |
| EmailAssunto | string | Assunto do e-mail enviado. |
| EmailMensagem | string | Corpo da mensagem enviada no e-mail. Caso não deseje enviar o PDF em anexo, você pode usar a variável ${linkBoleto} no corpo do e-mail. Caso a mensagem não seja HTML (ou seja, EmailConteudoHtml seja false) pode-se utilizar o caractere pipe (|) para quebrar a linha. |
| EmailDestinatario | array | Objeto array com os e-mails dos destinatários. Os e-mails devem ter a vírgula como separador. |
| EmailAnexarBoleto | boolean | Caso não queira utilizar o variável do link, você pode anexar o boleto no envio de e-mail. Informe o valor true para que o mesmo seja enviado como anexo para o Sacado. Caso não seja informado, iremos assumir o valor false. |
| EmailConteudoHtml | boolean | Campo indica se o valor informado em EmailMensagem é um HTML ou texto normal. Informe o valor true para que o mesmo seja enviado como HTML. Caso não seja informado, iremos assumir o valor false. |
| TipoImpressao | string | Campo que determina o Layout da impressão "0" Impressão normal. "1" Impressao carnet duplo (paisagem). "2" Impressao carnet triplo (retrato). "3" Impressao dupla (retrato). "4" Impressão normal (Com marca D'água) "99" para impressão personalizada. |
| Anexos | Objeto | Array de objetos para adicionar outros anexos junto ao boleto, composto por: Arquivo: Campo onde deve ser informado o base64 do arquivo Nome: Nome do arquivo com extensão ex: Boleto.pdf O tamanho máximo da solicitação é de 4 MB (requisição/anexos). |
| EmailPersonalizacao | Objeto |
Opcional. Array de objetos voltado para informar o boleto e suas personalizações, o corpo do campo é composto: Boleto: Informado o idintegracao do boleto. Os demais campos são livres e voltados para informar a chave e valor da sua personalização, similar a rota de impressão. Vide exemplo abaixo. |
| EmailCco | Objeto |
Array de String, campo onde é informado os e-mails dos recipientes da cópia oculta. |
| EmailResponderPara | string |
Endereço de email no qual as respostas serão encaminhadas. |
| Password | string |
Senha do PDF. Caso informado, o PDF será criptografado. O tamanho máximo da senha é de 12 caracteres. |
Body
Exemplo de JSON:
{
"IdIntegracao": ["rkx50ao2Wg", "ByescqED3l", "HJgxLQsWWe"],
"EmailNomeRemetente": "Empresa Exemplo",
"EmailRemetente": "exemplo@remetente.com.br",
"EmailAssunto": "Boleto para pagamento",
"EmailConteudoHtml": true,
"EmailMensagem": "Segue o link do boleto:<br> ${linkBoleto}<br>Considere não imprimir este email.<br><b>Código HTML dentro da Tag</b>",
"EmailDestinatario": ["email1@tecnospeed.com.br", "email2@tecnospeed.com.br"],
"EmailCco": ["cco@tecnospeed.com.br", "cco2@tecnospeed.com.br"],
"EmailAnexarBoleto": true,
"Anexos":[
{
"Arquivo":"base64",
"Nome":"nome.extensão do arquivo"
},
{
"Arquivo":"base64",
"Nome":"nome.extensão do arquivo2"
}
],
"EmailPersonalizacao": [
{
"boleto": "idintegracao",
"variavel": "Teste com a Variável"
}
]
}
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"situacao": "PROCESSANDO",
"protocolo": "SkR1z8B-G"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Boleto não encontrado.",
"_dados" : []
}
}
Exemplo de retorno com erro por exceder o limite de 4MB:
{
"_status": "erro",
"_mensagem": "Requisição inválida",
"_dados": [
{
"_erro": "Requisição excedeu o limite. Tamanho máximo: 4mb"
}
]
}
Em caso de sucesso, a rota irá retornar um número de protocolo através do campo protocolo. Isso acontece pois a rota é assíncrona. Usando esse número de protocolo, nosso próximo passo é consultá-lo e verificar o resultado do processamento do envio do email.
Solicitando envio de e-mail para o Sacado via Portal do Cedente
Primeiramente é necessário realizar o acesso através do portal do cedente
Onde após isso é necessário observar os boletos e clicar nos 3 "pontinhos" a direta do mesmo e selecionar a opção "Enviar e-mail" conforme a imagem abaixo:
Após isso seria apenas preencher os campos correspondentes e clicar em "Enviar" conforme abaixo:
Comentários
1 comentário
Existe alguma parametrização para que não tenha intervalo nos envios dos boletos. ex: Hoje quando a data de envio de boleto cai no fim de semana, o mesmo não e enviado.
e possível alterar ?
Por favor, entre para comentar.