Gestión de Plantillas de Documentos
La Gestión de Plantillas de Documentos es la interfaz donde puedes cargar, editar y administrar las plantillas que contienen los IDs documentados anteriormente. Estas plantillas se utilizan posteriormente con el endpoint de exportación para generar documentos personalizados con la información extraída de las verificaciones.¿Qué son las Plantillas de Documentos?
Las plantillas de documentos son archivos (PDF o Word) que contienen IDs (marcadores de posición) que serán reemplazados automáticamente con la información extraída de las verificaciones. Por ejemplo, si tienes un documento que dice “La empresa{rut_co-1-businessName}
con NIT {rut_co-1-nit}
”, estos IDs serán reemplazados con los datos reales de la verificación.
Acceso a la Gestión de Plantillas
Para acceder a la gestión de plantillas:- Inicia sesión en la aplicación web de Trébol
- Navega a Ajustes (En el menú de la parte superior derecha)
- Selecciona “Plantillas de formatos” en el menú lateral
Funcionalidades Disponibles
Visualizar Plantillas Existentes
La interfaz muestra una tabla con todas las plantillas cargadas, incluyendo:Campo | Descripción |
---|---|
Nombre | Nombre descriptivo de la plantilla |
Identificador | ID único de la plantilla (usado para referencias) |
Tipo de documento | Extensión del archivo (PDF, DOCX, etc.) |
Fecha de creación | Cuándo fue cargada la plantilla |
Documento | Enlace para ver el archivo original |
Acciones | Opciones para editar o eliminar |
Crear Nueva Plantilla
1
Preparar el documento
Crea tu documento (PDF o Word) incluyendo los IDs que necesites. Por ejemplo:
2
Cargar la plantilla
En la interfaz de gestión: 1. Haz clic en “Cargar nueva plantilla” 2.
Completa el formulario con: - Nombre: Nombre descriptivo de la plantilla -
Archivo: Selecciona tu documento (PDF o Word) 3. Haz clic en “Guardar”
3
Verificar la carga
La plantilla aparecerá en la tabla con:
- Un identificador único generado automáticamente
- El tipo de documento detectado
- La fecha de creación actual
Editar Plantilla Existente
1
Acceder a la edición
- En la tabla de plantillas, haz clic en el menú de acciones (⋮) de una de ellas
- Selecciona “Editar”
2
Modificar la plantilla
Puedes cambiar: - Nombre de la plantilla
No puedes cambiar el archivo cargado. Para esto debes crear una plantilla
nueva mejor
3
Guardar cambios
Haz clic en “Guardar” para aplicar los cambios.
Eliminar Plantilla
1
Confirmar eliminación
- En la tabla de plantillas, haz clic en el menú de acciones (⋮)
- Selecciona “Eliminar”
- Confirma la acción en el modal que aparece
2
Verificar eliminación
La plantilla será eliminada permanentemente de la tabla.
Esta acción no se puede deshacer. Asegúrate de que la plantilla no esté siendo utilizada antes de eliminarla.
Mejores Prácticas para Plantillas
Estructura del Documento
Organiza tu documento de manera clara: - Usa títulos y subtítulos para
organizar la información - Agrupa campos relacionados (datos de la empresa,
contactos, etc.) - Incluye espacios suficientes para que los datos se vean
bien al reemplazarse
Uso de IDs
Para usar los IDs correctamente: - Copia exactamente los IDs de la
documentación (incluyendo llaves
{}
) - Usa la numeración correcta (-1
,
-2
, etc.) según el número de documentos - Para arrays, usa el índice
correcto (-0
, -1
, etc.) - Prueba con diferentes verificaciones para
asegurar que los IDs funcionenEjemplo de Plantilla Completa
Integración con el Endpoint de Exportación
Una vez que tienes tus plantillas cargadas, puedes usarlas con el endpoint de exportación para generar documentos personalizados:- Identifica la plantilla que quieres usar (por su identificador)
- Llama al endpoint
POST /verifications/{id}/export/{id_plantilla}
- Recibe la url del archivo y otros datos adicionales como el tiempo de expiracion del enlace(en milisegundos)
- Descarga el archivo accediendo a la url obtenida del paso anterior
Permisos Requeridos
Para gestionar plantillas, necesitas los siguientes permisos:Acción | Permiso Requerido |
---|---|
Crear plantillas | doc-templates:create |
Editar plantillas | users:update |
Eliminar plantillas | doc-templates:delete |
Ver plantillas | Acceso básico a la interfaz |
Solución de Problemas
IDs no se reemplazan
Verificar sintaxis de IDs
Verificar sintaxis de IDs
- Asegúrate de que los IDs estén entre llaves
{}
- Verifica que no haya espacios extra dentro de las llaves
- Confirma que el ID existe en la documentación
Verificar datos de la verificación
Verificar datos de la verificación
- Confirma que la verificación tiene items del tipo correcto - Verifica que los items tienen datos completos - Asegúrate de que la verificación está en estado “finished”
Verificar numeración
Verificar numeración
- Usa la numeración correcta (
-1
,-2
, etc.) - Confirma que existe al menos un documento del tipo especificado
- Para arrays, usa índices válidos (
-0
,-1
, etc.)
Error al cargar plantilla
Formato de archivo
Formato de archivo
- Asegúrate de que el archivo sea PDF o Word (.docx) - Verifica que el archivo no esté corrupto - Confirma que el archivo no esté protegido con contraseña