API de PDF/A para geração de PDFs de arquivamento
Gere saída PDF/A a partir de requisições JSON Render para fluxos de arquivamento, com fronteiras claras entre perfis PDF/A e empacotamento de e-invoice.
/api/v1/pdf/render Gerar saída com perfil PDF/A a partir de requisições estruturadas de documento quando um fluxo de negócio precisa de PDFs adequados a arquivamento, escolhendo E-Invoice Render somente quando o empacotamento de fatura com XML incorporado for necessário.
Quando usar esta API
- Seu fluxo precisa de um perfil PDF/A selecionado nas configurações de renderização.
- Você precisa de saída de fatura, extrato, relatório ou documento para arquivamento.
- Você quer uma página geral de PDF/A mais ampla que o empacotamento de e-invoice PDF/A-3b.
- Você consegue validar o arquivo produzido com seu próprio fluxo de aceite de arquivo.
O que ela não substitui
- Você precisa de Factur-X ou ZUGFeRD com EN 16931 CII XML incorporado. Use E-Invoice Render.
- Você precisa de um fluxo apenas de validação. Use as páginas do validador para contexto de validação.
- Você precisa de saída criptografada e PDF/A na mesma requisição. A Render API pública trata configurações de segurança e configurações de perfil PDF/A como mutuamente exclusivas.
Qual endpoint chamar
/api/v1/pdf/render
JSON Render é o caminho padrão para este fluxo.
/api/v1/e-invoice/render
Use quando o fluxo precisar da API relacionada, de um contrato de template ou de uma consulta de capacidades.
Request mínimo
POST /api/v1/pdf/render - configuração comum de saída PDF/A.
{
"settings": {
"profile": "pdfa-2b"
},
"pages": [
{
"size": "a4",
"elements": [
{
"type": "text",
"x": 20,
"y": 24,
"content": "Archive-ready document",
"style": { "font_size": 16, "font_family": "NotoSans-Regular" }
}
]
}
]
}
O que a gPdf faz
- Configurações de perfil PDF/A em requisições JSON Render.
- Renderização de documento com texto, tabelas, imagens, códigos de barras, metadados e saída por perfil.
- Empacotamento de e-invoice PDF/A-3b somente pelo caminho E-Invoice Render.
- Resposta binária em PDF com comportamento compartilhado de erro.
O que seu sistema controla
- Política de arquivamento, seleção de perfil, fluxo de validação, retenção e aceite legal.
- Semântica do documento, dados de negócio e qualquer evidência externa exigida.
- Armazenamento, controle de acesso e política futura de migração.
Checklist de produção
- Selecione o perfil PDF/A exigido pelo seu arquivo ou cliente.
- Passe a saída pelo seu validador e fluxo de aceite de retenção.
- Mantenha PDF/A e configurações de segurança em fluxos de renderização separados, a menos que a documentação pública adicione um contrato compatível.
- Use E-Invoice Render quando CII XML incorporado for necessário.
- Armazene os dados de origem ou o PDF retornado de acordo com a política de retenção.
Limites da promessa
- Saída PDF/A não é a mesma coisa que empacotamento legal de e-invoice.
- O gPdf não substitui seu fluxo de aceite de arquivo ou validação.
- Seu sistema controla retenção e interpretação de compliance.
PDF/A é uma escolha de perfil
Para documentos comuns de arquivamento, PDF/A é selecionado pelas configurações de renderização. Isso mantém o fluxo próximo do JSON Render: seu sistema descreve o documento e define o perfil de que precisa.
Empacotamento de e-invoice é diferente. Quando o documento precisa de Factur-X ou ZUGFeRD com CII XML incorporado, use o endpoint E-Invoice Render.
FAQ
- Qual endpoint devo usar para saída PDF/A geral?
- Use POST /api/v1/pdf/render com o valor settings.profile apropriado para saída PDF/A comum.
- Quando preciso de E-Invoice Render?
- Use E-Invoice Render quando o documento precisa ser um pacote Factur-X ou ZUGFeRD PDF/A-3b com CII XML incorporado.
- O gPdf valida aceite de arquivamento?
- Não. O gPdf renderiza saída PDF/A. Seu sistema deve validar a saída contra a política de aceite do arquivo ou do cliente.
- PDF/A pode ser combinado com configurações de segurança?
- Não na Render API pública atual. settings.profile e settings.security são mutuamente exclusivos, e combinações inválidas falham na validação.