Nesse passo vamos precisar apenas do IdIntegracao para solicitar o PDF.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/boletos/impressao/lote
Produção:
https://plugboleto.com.br/api/v1/boletos/impressao/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 o PDF, o objeto JSON pode ter os seguintes campos:
Campo | Tipo | Descrição |
TipoImpressao | string |
Valores aceitos: 0 - PDF normal. 1 - PDF carnê duplo (paisagem). 2 - PDF carnê triplo (retrato). 3 - PDF dupla (retrato). 4 - PDF normal (Com marca D'água). 99 - PDF personalizada. |
Boletos | array | Array de Ids de integração. Para mais de um boleto, deve-se usar a vírgula como separador. |
Personalizacao | Objeto | Objeto com variáveis livres, informadas na personalização. |
Body
Exemplo de JSON:
{
"TipoImpressao" : "1",
"Boletos" : [
"IdIntegracao1",
"IdIntegracao2"
]
}
Apenas as situações EMITIDO, REGISTRADO e LIQUIDADO permitem a geração do PDF. Ah, lembre-se que, para imprimir mais de um Id, você deve informar a vírgula como separador.
Exemplo de JSON utilizando a variável de personalização:
- Primeiramente, para utilizar a variável de personalização, você precisa acessar a área do cedente, e inserir sua variável no HTML de edição dos boletos, conforme demonstrado na nossa documentação de personalização (https://atendimento.tecnospeed.com.br/hc/pt-br/articles/360018691873-Como-personalizar-impress%C3%A3o) e exemplo deixado a seguir:
- Desse modo, na imagem disponibilizada acima, o usuário realizou a inserção da variável personalizada no corpo do HTML, conforme a nossa orientação: {personalizacao.variavel}.
- Após inserir a variável no corpo do HTML, basta enviar o JSON de acordo com o exemplo disponibilizado abaixo:
Obs 1: lembrando que você pode dar o nome que desejar para a sua variável, neste exemplo, foi utilizado o nome "variavel", mas você é livre para escolher o nome que preferir. A única parte que deve seguir o exemplo é {personalizacao.nomeDaSuaVariavel}.
- Por fim, caso você queira realizar a utilização de tabelas na impressão do seu boleto, recomendamos que no preenchimento do HTML na área do cedente, a tag "<tr>" seja substituída por "<br>".
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_mensagem": "Impressão em processamento",
"_dados": {
"situacao": "PROCESSANDO",
"protocolo": "S1xeMu5TbZ"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Id(s) informado(s) não encontrado(s).",
"_dados": [
{
"boletos": [
"IdIntegracao1",
"IdIntegracao2"
]
}
]
}
- Em nossa rota de impressão, possuímos um limite de solicitações de até 100 (cem) boletos por chamada, para os tipos: 0, 1, 2, 3 e 4.
- Para o tipo de impressão personalizada (99), possuímos um limite de 50 boletos por chamada em nossa rota de impressão.
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 da geração do PDF.
Comentários
0 comentário
Por favor, entre para comentar.