Guia do produto e da API

Links de prévia

Configurações do visualizador e da incorporação

Configure aparência, visibilidade do título e navegação nas configurações do visualizador incorporado da conta. Remoção de marca e incorporação dependem do plano; confira a disponibilidade no painel.

Sites permitidos

Adicione aos sites permitidos os locais onde incorporará o visualizador. A permissão de incorporação e a validade do compartilhamento são verificações separadas: permitir um site não reativa um link expirado ou revogado. Nunca coloque uma chave de API no código do navegador ou na URL de um iframe.

Verifique antes de compartilhar

Teste o link nas condições do destinatário. Confira páginas, layout de gráficos e tabelas, formatos de download e expiração. Teste também a incorporação em um site não permitido; uma prévia funcional na conta não comprova que o acesso externo está habilitado.

Cria um link temporário de visualização que seu cliente pode abrir sem conta. Uma única chamada pode retornar links de download de PDF e DOCX.

Solicitação 
curl -X POST https://api.pdfgine.com/api/v1/preview \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "templateCode": "invoice", "formats": ["pdf", "docx"], "data": { } }'
Resposta 
{
  "previewId": "prv_481fac83d9f14a4493021eb128d0876b",
  "previewUrl": "/p/prv_481fac83d9f14a4493021eb128d0876b",
  "expiresAt": "2026-08-29T13:23:43+00:00",
  "pageCount": 1,
  "downloads": [
    { "format": "pdf", "downloadUrl": "/api/v1/previews/prv_481f.../download/pdf?expires=...&token=..." },
    { "format": "docx", "downloadUrl": "/api/v1/previews/prv_481f.../download/docx?expires=...&token=..." }
  ]
}

O link contém uma assinatura impossível de adivinhar e encerra em expiresAt.

Por quanto tempo os documentos ficam disponíveis

O PDFgine gera e entrega documentos; mantê-los é sua escolha. O produto armazena apenas suas entradas (modelos e recursos de marca) e saídas temporárias. Cada saída fica pelo período escolhido na solicitação: accessProfile: short 24 horas (padrão), standard 7 dias, extended 30 dias (7 e 30 dias a partir do Go), quarter 90 dias (no Max). Um link compartilhado fica aberto por esse período; um documento de produção (/render, /documents/render) pode ser baixado novamente pela API no mesmo prazo. Ao terminar, downloads retornam 410 e a saída é excluída em até 24 horas; o registro de geração, a contagem de páginas e os dados de uso permanecem. Para guardar permanentemente, armazene o documento no seu sistema logo após a geração.

Links de noventa dias

Além dos perfis standard e extended, há o perfil quarter, que mantém um link ativo por 90 dias, para contratos que a outra parte precisa reabrir durante um trimestre inteiro. Ele está disponível no plano superior; cada plano mostra os perfis permitidos em suas autorizações.

Encerrar um link antecipadamente

Um link compartilhado normalmente encerra em expiresAt. Quando o documento não deve mais ser visto, revogue-o: a resposta é 204 e o link para de funcionar imediatamente.

cURL 
curl -i -X POST https://api.pdfgine.com/api/v1/previews/prv_481fac83d9f14a4493021eb128d0876b/revoke \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

HTTP/1.1 204 No Content

Os problemas mais comuns

  • Criar uma prévia responde 201, não 200; revogar responde 204 sem corpo. Um cliente que interpreta todas as respostas como JSON falha na revogação.
  • accessProfile define a duração do link, e os perfis mais longos exigem o plano adequado. Pedir quarter em um plano que não o inclui é recusado, não encurtado silenciosamente.
  • Os links em downloads possuem assinatura e expiração. Guarde previewId, não esses endereços; um endereço armazenado deixa de funcionar quando expira.
  • Revogar encerra o link, não o documento. O arquivo continua sendo seu e pode ser baixado pela API até o fim da retenção.
  • Uma prévia consome páginas de prévia, não a cota de produção. Produzir o mesmo documento novamente com /render gera uma nova contagem de páginas faturáveis.