Guía del producto y de la API

Diseñar en el Generador

Empieza con una plantilla

Crea una plantilla desde Plantillas en tu cuenta o abre una existente en el Generador. Usa Recursos para añadir texto, títulos, tablas, imágenes o gráficos. Al seleccionar un elemento del lienzo, sus ajustes aparecen en el Inspector.

Diseño y espacio disponible

Usa Diseño para posición, tamaño y alineación, y Estilo para tipografía y relleno. El posicionamiento de flujo sigue el orden del documento; el absoluto sirve para elementos con una posición concreta. Prefiere el flujo para informes que crecen y comprueba los saltos con datos largos.

Tamaño, márgenes y relleno

Un ancho del 100% llena el área contenedora, no toda la hoja. Los márgenes reducen el área útil del documento y el relleno reduce el espacio dentro de un elemento. Las tablas y los gráficos dentro de columnas también están limitados por el ancho de la columna.

Haz lo mismo a través de la API

El editor guarda la definición de la plantilla mediante el mismo endpoint que puedes llamar tú. Lee la definición actual, modifícala y vuelve a guardarla con la versión que leíste, para no sobrescribir accidentalmente un cambio que otra persona haya publicado mientras tanto.

cURL
# 1 - Descargar la definición con la que trabaja el editor
curl -s https://api.pdfgine.com/api/v1/templates/invoice \
  -H "X-PDFgine-Key: $PDFGINE_KEY" > invoice.json

# 2 - Editar el objeto "definition" dentro de invoice.json

# 3 - Guardarlo con el mismo número de versión
curl -X POST https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "code": "invoice",
        "name": "Invoice",
        "saveMode": "manual",
        "expectedVersion": 1,
        "changeReason": "Logotipo movido al margen derecho.",
        "definition": { "page": { "size": "A4", "orientation": "portrait" }, "elements": [] }
      }'

expectedVersion garantiza la seguridad. Si la plantilla ha cambiado, se rechaza la escritura con un 409 y la respuesta incluye la versión actual; vuelve a leer, aplica otra vez tu cambio y guarda de nuevo.

Guardar y comprobar las salidas

Guarda los cambios y comprueba la vista previa y la salida PDF o Word que necesites. Un ejemplo que cabe en el lienzo puede generar más páginas con datos reales más largos. Revisa juntos títulos, tablas, etiquetas de gráficos y saltos de página antes de publicar.

Generador de datos de tabla →

Los errores más habituales

  • Lo que ves en el editor es el borrador. Hasta que publiques, todas las renderizaciones de producción seguirán usando la versión publicada anterior.
  • Los datos de ejemplo son más cortos que los reales. Un diseño que cabe en el lienzo puede ocupar una segunda página al recibir un nombre de cliente real, una dirección y treinta filas.
  • 100% se refiere al área contenedora, no a la hoja. Los márgenes y el relleno se descuentan antes de asignar el ancho al elemento.
  • El posicionamiento absoluto no se aparta. Un elemento con coordenadas fijas permanece en su sitio mientras el contenido de flujo crece; usa flow para todo lo que pueda abarcar varias páginas.
  • Dos personas guardando la misma plantilla producen un 409, no una fusión. La escritura incluye la versión de partida y se rechaza si esa versión ha cambiado.