A personalização de impressão é utilizado para adicionar detalhes da empresa na impressão, como: cobrança, informações do sacado e também disponibiliza adicionar uma logo na sua impressão.
Esta personalização é feita com um conteúdo HTML, portanto é possível adicionar tabelas, imagens e marcações no texto.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/cedentes/boletos/personalizar
Produção:
https://plugboleto.com.br/api/v1/api/v1/cedentes/boletos/personalizar
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-sh | CNPJ ou CPF da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpj-cedente | CNPJ ou CPF do cedente | 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 |
Body
| Campo | Tipo | Descrição |
|
conteudo
|
string | conteúdo HTML |
|
layout
|
string | valores aceitos 'normal' e 'completo' |
|
arquivo (opcional)
|
string | Arquivo deve se passado no formato base64 |
|
formato (opcional)
|
string |
Formatos aceitos:
'jpg', 'ico', 'png', 'jpeg', 'tiff', 'pjp', 'gif', 'svg', 'bmp', 'svqz' |
Obs: Ao informar o campo 'arquivo' é necessário informar também o campo 'formato'.
Exemplo:
{
"conteudo": "<p>Cnpj: {pagador.cpf-cnpj}</p><img src='{imagem.logo}'></img>",
"layout": "normal",
"formato": "png",
"arquivo": "iVBORw0GgoAAANSUhEug..."
}
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"html": "<html>Exemplo...</html>",
"conteudo": "<p>Cnpj: {pagador.cpf-cnpj}</p><img src='{imagem.logo}'></img>
"layout": "normal"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "conteudo",
"_erro": "base64 informato está inválido!"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.