Guía del producto y de la API

Enlaces de vista previa

Ajustes del visor y la inserción

Configura apariencia, visibilidad del título y navegación en los ajustes del visor insertado de tu cuenta. La eliminación de marca y la inserción dependen del plan; comprueba la disponibilidad indicada en el panel.

Sitios permitidos

Añade a los sitios permitidos aquellos donde insertarás el visor. El permiso de inserción y la validez del enlace son comprobaciones independientes: permitir un sitio no reactiva un enlace caducado o revocado. Nunca pongas una clave API en el código del navegador ni en una URL de iframe.

Comprueba antes de compartir

Prueba el enlace en las condiciones del destinatario. Comprueba páginas, disposición de gráficos y tablas, formatos de descarga y caducidad. Prueba también la inserción en un sitio no permitido; una vista previa de cuenta que funciona no demuestra que el acceso externo esté habilitado.

Crea un enlace de visualización temporal que tu cliente puede abrir sin cuenta. Una sola llamada puede devolver enlaces de descarga tanto de PDF como de DOCX.

Solicitud 
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": { } }'
Respuesta 
{
  "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=..." }
  ]
}

El enlace incluye una firma impredecible y se cierra en expiresAt.

Cuánto tiempo están disponibles los documentos

PDFgine genera y entrega documentos; conservarlos es tu decisión. El producto guarda solo sus propias entradas (plantillas y recursos de marca) y salidas temporales. Cada salida permanece durante el plazo elegido en la solicitud: accessProfile: short 24 horas (predeterminado), standard 7 días, extended 30 días (7 y 30 días desde Go), quarter 90 días (en Max). El enlace compartido permanece abierto ese plazo; un documento de producción (/render, /documents/render) puede descargarse de nuevo mediante la API durante el mismo plazo. Al terminar, las descargas devuelven 410 y la salida se elimina en 24 horas; el registro de generación, el número de páginas y los datos de uso se conservan. Para conservar un documento permanentemente, guárdalo en tu sistema justo después de generarlo.

Enlaces de noventa días

Además de los perfiles standard y extended, existe el perfil quarter, que mantiene un enlace activo durante 90 días para contratos que la otra parte deba poder reabrir durante un trimestre completo. Está disponible en el plan superior; cada plan muestra los perfiles que puede utilizar en sus permisos.

Cerrar un enlace antes de tiempo

Un enlace compartido suele cerrarse en expiresAt. Si el documento ya no debe verse, revócalo: la respuesta es 204 y el enlace deja de funcionar inmediatamente.

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

Los errores más habituales

  • Crear una vista previa responde 201, no 200, y revocarla responde 204 sin cuerpo. Un cliente que interpreta todas las respuestas como JSON falla al revocar.
  • accessProfile determina la duración del enlace y los perfiles más largos requieren el plan adecuado. Solicitar quarter en un plan que no lo incluye se rechaza; no se reduce su duración silenciosamente.
  • Los enlaces de descarga dentro de downloads incluyen una firma y una fecha de caducidad. Guarda previewId, no esas direcciones; una dirección guardada deja de funcionar al caducar.
  • La revocación cierra el enlace, no el documento. El archivo sigue siendo tuyo y se puede descargar mediante la API hasta que termine su conservación.
  • Una vista previa consume páginas de vista previa, no cuota de producción. Volver a generar el mismo documento con /render supone un nuevo recuento de páginas facturable.