Após fazermos a solicitação de envio do email, chegou a hora de consultar o protocolo obtido para efetivamente, receber o resultado o envio de seu email.
Para fazermos essa consulta, vamos precisar do protocolo gerado na requisição anterior.
GET
Homologação:
https://homologacao.plugboleto.com.br/api/v1/email/lote/:protocolo
Produção:
https://plugboleto.com.br/api/v1/email/lote/:protocolo
*Aqui temos um exemplo da URL completa, informando um número de protocolo
Headers
Nome | Descrição | Exemplo |
cnpj-sh | CNPJ da Software House | 01001001000113 |
token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
cnpj-cedente | CNPJ do Cedente (emitente) | 01001001000113 |
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 |
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"situacao": "PROCESSADA",
"_mensagem": "E-mail enviado com sucesso para: email1@tecnospeed.com.br"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Protocolo inválido ou inexistente."
}
Exemplo de retorno 'Envio do email em processamento':
{
"_status": "sucesso",
"_dados" : [
"situacao": "PROCESSANDO"
}
}
O status acima indica que o e-mail ainda está em processamento na nossa API. Isso geralmente acontece quando você envia muitos boletos no e-mail. Fique tranquilo, se você tiver esse retorno basta refazer a consulta (passando o mesmo protocolo informado inicialmente) até obter a resposta de sucesso.
Uma implementação interessante neste caso, é colocar este método de consulta do protocolo em um While, que refaz a consulta caso a situação seja igual a "Processando", com um delay de pelo menos 5 segundos entre cada consulta.
Após a resposta de sucesso você já pode verificar a caixa de entrada do destinatário para ter acesso aos boletos enviados para o e-mail. Finalizado o envio de e-mail, vamos para o nosso próximo passo que é a geração de remessa.
Comentários
0 comentário
Por favor, entre para comentar.