Variáveis personalizadas para impressão
ATENÇÃO: As variáveis personalizadas para impressão não são compatíveis com a impressão enviada através das notificações por agendamento e por evento. Caso queira enviar a impressão com variáveis personalizadas será necessário utilizar o envio de e-mail normal, passando a impressão como anexo.
Nossa API conta com um recurso para personalizar variáveis de impressão, ou seja, na impressão personalizada seria possível informar detalhes que não estão presentes no boleto, por exemplo informação do produto onde originou a cobrança.
Pré requisitos para utilizar o recurso:
- Acessar a nossa GUI e configurar a impressão personalizada.
- Realizar integração via API.
Esta integração não é possivel ser realizada via OCX.
Após configurar as variáveis na personalização, basta solcitar a impressão seguindo o seguinte padrão de JSON
Composição do JSON
| Nome | Descrição | Exemplo |
| TipoImpressao | Define o tipo da impressão, para utilizar a personalização deve ser informado o valor 99 |
"TipoImpressao": "99" |
| personalizacao | Array de JSON, onde deve ser informado o boleto e os campos livres (variáveis) |
{"boleto": "idintegracao","variavela": "Teste com a Variável A"} |
No array de personalização é obrigatório informar o campo boleto neste campo deve ser informado o IDintegração que deseja para a personalização.
Composição do array personalizacao
| Nome | Descrição | Exemplo |
| boleto | Campo String onde deve ser informado o IDintegracao para ser personalizado na impressão. | "boleto": "B1mTXmrmQ" |
| Campo Livre | Campo Livre onde deve ser informado a variável configurada na personalização. Exemplo, se configurar na GUI o valor {personalizacao.variavel} deve ser informado o valor variavel |
"variavel": "Mensagem personalizada." |
Segue abaixo um exemplo de JSON montado
{
"TipoImpressao": "99",
"personalizacao": [
{
"boleto": "idintegracao",
"variavel": "Teste com a Variável"
}
]
}
Para informar mais de uma variável basta configura-la na em nossa GUI, (Dúvidas de como informar na GUI clique aqui.) e repetir no JSON como no exemplo abaixo.
{
"TipoImpressao": "99",
"personalizacao": [
{
"boleto": "idintegracao",
"variavel": "Teste com a Variável",
"variavel2": "Teste com a segunda Variável"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.