Consultando o protocolo da solicitação do PDF

Impressão em Lote

Após fazermos a solicitação da geração do PDF, chegou a hora de consultar o protocolo obtido para efetivamente, receber o resultado da geração do PDF

Para fazermos essa consulta, vamos precisar do protocolo gerado na requisição anterior.

 

 

GET

 Homologação:

 Produção:

 

 *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:

 

Em caso de sucesso a consulta vai nos devolver o conteúdo (buffer) do arquivo PDF, ou seja, não vamos ter uma resposta em JSON. A partir dai, basta salvar esse arquivo PDF no diretório desejado.

 

Exemplo de retorno com erro:

 

 

Exemplo de retorno 'Impressão em processamento':

 

O status acima indica que o PDF ainda está em processamento na nossa API. Isso geralmente acontece quando você envia muitos boletos para a impressão. Fique tranquilo, se você tiver esse retorno basta refazer a consulta (passando o mesmo protocolo informado inicialmente) até que o PDF seja devolvido.

 

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.

 

Com o PDF em mãos, podemos ir para o nosso próximo passo, que é o envio de e-mail.

Impressão Individual

Na impressão individual, temos algumas mudanças, nesse modelo de impressão, podemos imprimir boletos em dois locais, na GUI do Cedente e API. Na GUI do cedente, basta clicar duas vezes em cima do boleto e o PDF já será exibido. Pela API, é possível coletar o hash de impressão, no campo "IdImpressao" ou já coletar a URL no campo "UrlBoleto". A URL é formada dessa maneira: "urlBase + IdImpressao".

O hash é exibido dessa forma:

 

GET

 Homologação:

 Produção:

 

 *Aqui temos um exemplo da URL completa, informando um número de protocolo:

Retorno

 

Exemplo de retorno:

 

Em caso de sucesso a consulta vai nos devolver o conteúdo (buffer) do arquivo PDF, ou seja, não vamos ter uma resposta em JSON. A partir dai, basta salvar esse arquivo PDF no diretório desejado.

 

Exemplo de retorno com erro: