Antes de empezar
Para ayudarlo a familiarizarse con Tembuilder, lo guiaremos en la creación de su primer PDF a partir de una plantilla de factura existente. Intentará editar el contenido, cambiar los datos y obtener una vista previa del resultado antes de generar un PDF, todo dentro de la aplicación.
Antes de comenzar, inicia sesión y ve al panel de control Plantillas. Puede agregar una plantilla a su proyecto utilizando cualquiera de los métodos siguientes.
1. Elige y abre una plantilla
Utilice un archivo ZIP existente o elija una plantilla de Gallery.
Método 1: Importar un archivo ZIP
Descargue la plantilla de factura (.zip), haga clic en Importar en Plantillas y seleccione el archivo descargado. Ingrese un nombre y un slug para la plantilla, luego espere a que finalice la importación.
Método 2: Elija una plantilla de Gallery
Abra Gallery, seleccione una plantilla de factura y obtenga una vista previa del diseño. Agréguelo a su proyecto, ingrese un nombre y un slug, y espere a que se complete.
Abre la plantilla en el editor
Después de agregar una plantilla usando cualquiera de los métodos, ábrala en Plantillas para comenzar a editar.
En el editor, seleccione una sección en Structure. Las pestañas HTML, CSS, Props y Config disponibles dependen de su selección. Intente cambiar una etiqueta en Props si la plantilla proporciona ese campo, luego verifique la vista previa.
2. Pruebe los datos y obtenga una vista previa
Abra Parameters → Schema para inspeccionar los nombres de campo y los valores predeterminados. Mantenga los nombres sin cambios. Diseño muestra las ediciones de diseño actuales.
Guarde la plantilla antes de abrir PDF. La vista previa de PDF utiliza el contenido de la plantilla guardada y los valores de los parámetros del editor, inicialmente completados desde Defaults. Después de guardar otro cambio, regenera el PDF para verlo; la vista previa anterior no se actualiza automáticamente. La vista previa no consume cuota de renderizado.
Las entradas en Run están separadas de la vista previa de PDF. Para probar nuevos valores de Run, renderice e inspeccione el resultado de ese trabajo en los pasos 3 y 4.
La muestra JSON usa invoiceNumber, seller, customer y lineItems, que coinciden con el ZIP anterior. Para otras plantillas, consulte su propio Parameters. Al llamar a API, coloque el objeto de datos dentro de parameters.
3. Guardar, publicar y generar
- Guarde sus cambios, seleccione la versión correcta y publíquela.
- Cree una clave API de proyecto con permiso
template:rendersi es necesario. - Abra Run, seleccione la clave, versión y variante e ingrese los datos.
- Haga clic en Renderizar y espere a que finalice.
Los renders reales requieren una versión publicada. Cada renderizado exitoso consume cuota; una vista previa funcional por sí sola no significa que una plantilla esté lista para renderizarse.
4. Descargue y verifique
Después del éxito, abra el resultado y descargue PDF. También puedes encontrar el trabajo en Renders. Verifique la primera página, la última página y las filas de datos en el archivo descargado.
Si falla, lea los detalles del error antes de volver a intentarlo. Cada clic en Render puede crear un nuevo trabajo. Consulte errores comunes si no puede identificar la causa.