API de etiquetas de devolução para sistemas de produção
Gere etiquetas de devolução 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 etiquetas de devolução 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 etiquetas de devolução 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 - etiquetas de devolução
{
"pages": [
{
"size": "label_4_6_in",
"elements": [
{
"type": "text",
"x": 5,
"y": 8,
"content": "RETURN TO",
"style": { "font_size": 9, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 5,
"y": 18,
"content": "Acme Returns\n500 Dock Door 4\nColumbus OH 43215",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
},
{
"type": "barcode",
"format": "code128",
"content": "RMA-2026-77881",
"x": 5,
"y": 70,
"width": 88,
"height": 20,
"barcode_text": { "enabled": true, "position": "bottom" }
}
]
}
]
}
O que a gPdf faz
- Rendering PDF de etiquetas de devolução 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 etiquetas de devolução, 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 o PDF da etiqueta; não compra frete, não cria remessas e não certifica transportadoras.
- Seu sistema mantém payloads, impressoras, estoque de etiquetas, roteamento e testes de leitura.
Formato da API
API de etiquetas de devolução é 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 etiquetas de devolução 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 etiquetas de devolução 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.