API de recibos em PDF para sistemas de produção
Gere recibos em PDF a partir de dados estruturados do backend, sem navegador, com fronteira clara entre o PDF renderizado pela gPdf e as regras do seu sistema.
/api/v1/pdf/render Gerar recibos em PDF como PDF reproduzível a partir de dados estruturados. Seu sistema mantém a lógica de negócio; a gPdf cuida do rendering PDF.
Quando usar esta API
- Seu backend já possui os dados de recibos em PDF e precisa de uma resposta PDF estável.
- Você quer evitar Chromium ou HTML-to-PDF em documentos operacionais.
- Você precisa de saída repetível para reimpressão, auditoria ou lotes.
O que ela não substitui
- Você precisa que a gPdf compre frete, liquide impostos, crie pedidos externos ou atue como sistema fiscal.
- Você precisa substituir validação de dados, regras de negócio ou integrações com marketplaces.
Qual endpoint chamar
/api/v1/pdf/render
JSON Render é o caminho padrão para este fluxo.
/api/v1/template-render
Use quando o fluxo precisar da API relacionada, de um contrato de template ou de uma consulta de capacidades.
Request mínimo
/api/v1/pdf/render - recibos em PDF
{
"pages": [
{
"size": "a6",
"elements": [
{
"type": "text",
"x": 10,
"y": 12,
"content": "Receipt R-2026-1001",
"style": { "font_size": 16, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 10,
"y": 28,
"content": "Order total: $82.40\nPaid by card ending 4242\nTax: $6.10",
"style": { "font_size": 10, "font_family": "NotoSans-Regular" }
},
{
"type": "barcode",
"format": "qrcode",
"content": "https://example.com/receipts/R-2026-1001",
"x": 10,
"y": 58,
"width": 28,
"height": 28
}
]
}
]
}
O que a gPdf faz
- Rendering PDF de recibos em PDF a partir de requests estruturados.
- Texto, tabelas, linhas, códigos de barras, páginas, metadados e opções de saída conforme o request.
- Saída determinística para retries, reimpressões e auditoria.
O que seu sistema controla
- Dados corretos de recibos em PDF, regras de negócio e estado operacional.
- Autenticação, persistência, integrações externas e validação com receptores finais.
Checklist de produção
- Teste com dados reais e com os sistemas que receberão o PDF.
- Armazene request IDs e evidências para suporte, auditoria e reimpressão.
- Promova o layout aprovado para template quando vários sistemas forem reutilizá-lo.
Limites da promessa
- A gPdf renderiza PDF a partir do request; não substitui workflow, banco de dados ou validação do produto.
- Seu sistema mantém semântica dos dados, retries, persistência e aceite final.
Formato da API
API de recibos em PDF é um workflow de produção sobre as APIs públicas da gPdf. O request descreve dados, layout, settings e partes do PDF que devem ser renderizadas. A gPdf renderiza o PDF; seu sistema mantém a semântica do evento de negócio.
Escolha do endpoint
Para este fluxo, o endpoint padrão é /api/v1/pdf/render. Use Template Render quando o layout estiver aprovado e reutilizado entre sistemas. Use E-Invoice Render apenas quando precisar do pacote Factur-X / ZUGFeRD PDF/A-3b com EN 16931 CII XML incorporado.
Validação antes da produção
Valide recibos em PDF com dados reais e com os sistemas que vão consumi-lo. Guarde request IDs, saída renderizada e evidências de validação para suporte, auditoria e reimpressão.
FAQ
- É um endpoint separado?
- API de recibos em PDF mapeia o fluxo para uma API pública da gPdf. A página mostra qual caminho chamar e o que o request deve fornecer.
- Posso usar templates?
- Sim. Use JSON Render enquanto o layout muda; use Template Render quando o layout estiver aprovado e os callers enviarem apenas dados de negócio.
- O que validar antes da produção?
- Valide com dados reais e com impressoras, scanners, validadores, sistemas contábeis ou marketplaces do fluxo.