TuID
Introducción
El propósito de este manual es detallar cómo configurar e integrar Qflow con TuID. El conector permite integrar Qflow con la plataforma de firma electrónica de TuID para iniciar y gestionar firmas de documentos PDF dentro de tus procesos.
TuID cuenta con las siguientes acciones:
Prerrequisitos
Es necesario contratar el servicio de TuID y obtener los datos del proveedor para conectarse con el servidor.
Parámetro de aplicación
Para entablar la conexión es necesario contar con al menos un parámetro de aplicación (ver Parámetros de aplicación) que permita establecer la comunicación entre Qflow y TuID. Este campo es utilizado para configurar el conector de una Tarea de Servicio en Qflow (ver Configuración de Conectores desde una Tarea de Servicio).
Para poder conectarnos con TuID se necesitan los siguientes datos del proveedor:
Host: URL del host del servicio TuID.
Clave de API: Clave de API generada en TuID para acceder a sus servicios.
Servidor de autenticación: URL del servidor de autenticación para servicios TuID.
Acciones
Se pueden realizar las siguientes acciones con TuID:
Crear proceso de firma
Esta acción permite seleccionar un documento y enviarlo a TuID para generar un proceso de firma. En los parámetros de entrada se configuran los estilos de la firma (opcionales) y el documento. En los parámetros de salida se obtiene información del proceso creado, concretamente, el identificador del proceso y la URL para firmar.
Parámetros de entrada
Entrada |
Descripción |
|---|---|
Documento |
Requerido. Documento en PDF (menos de 50 MB) a ser firmado. |
Evento al firmar |
Evento de atrapar señal que se activa al completarse la firma. Si se selecciona, el proceso continúa automáticamente cuando llegue a dicho evento y el documento haya sido firmado. |
Agregar representación visual de la firma |
Si se selecciona, la firma será visible en el PDF. Su posición y otros parámetros visuales pueden configurarse. Por defecto, se ubica en la esquina inferior derecha de la última página. La página por defecto donde se ubica la firma es la última página. |
Horizontal (Posición de la firma) |
Distancia del campo de firma al borde izquierdo de la página. Valor por defecto: 450. |
Vertical (Posición de la firma) |
Distancia del campo de firma al borde inferior de la página. Valor por defecto: 50. |
Ancho (Posición de la firma) |
Ancho del campo de firma en píxeles. Valor por defecto: 100. |
Altura (Posición de la firma) |
Altura del campo de firma en píxeles. Valor por defecto: 100. |
Página (Posición de la firma) |
Número de página donde debe colocarse el campo de firma. Ejemplos: |
Nombre (Fuente) |
Nombre de la fuente para el texto de la firma. Ejemplos: |
Tamaño (Fuente) |
Tamaño de la fuente para el texto de la firma. |
Estilo (Fuente) |
Estilo de la fuente para el texto de la firma. Ejemplos: |
Información de contacto (Datos del firmante) |
Información de contacto a incluir con la firma. |
Motivo (Datos del firmante) |
Motivo para firmar el documento. |
JSON del campo de firma (Avanzado) |
Configuración JSON para las propiedades del campo de firma. Si se completa, se ignoran todos los parámetros opcionales de estilo de firma. |
JSON del campo de firma (Avanzado)
Este parámetro permite configurar de forma avanzada la representación visual (apariencia) de la firma en el documento PDF mediante un objeto JSON. Esta funcionalidad se basa en la sección «Representación de firma (apariencia)» de la documentación de la API de TuID (sección 1.2.3.5.2).
Cuando se proporciona este parámetro JSON, se ignoran todos los parámetros individuales de estilo de firma configurados anteriormente (posición horizontal y vertical, ancho, altura, página, propiedades de fuente, información de contacto y motivo). El JSON debe contener todas las propiedades necesarias para definir completamente la apariencia del campo de firma en el documento, permitiendo una configuración más precisa y completa según las especificaciones de la API de TuID.
Para conocer los detalles técnicos específicos sobre la estructura y propiedades del objeto JSON, consulte la documentación oficial de la API de TuID.
Parámetros de salida
Salida |
Descripción |
|---|---|
URL del proceso de firma |
Requerido. URL del proceso de firma creado. Debe asociarse a un dato de aplicación de tipo texto para poder acceder al enlace de la firma. |
ID del proceso de firma |
Requerido. Identificador único del proceso. Se usa para consultar estado, obtener documento o eliminar el proceso. |
Obtener documento
Esta acción permite obtener un PDF firmado de TuID. Previamente se debe ejecutar la acción «Crear proceso de firma» para obtener el identificador del proceso.
Se debe ingresar un ID de proceso de firma y el nombre del PDF a generar. En base a eso obtiene el PDF, el cual debe asociarse a un dato de aplicación de tipo «Documento».
Parámetros de entrada
Entrada |
Descripción |
|---|---|
ID del proceso de firma |
Requerido. Identificador único del proceso de firma. Para obtener este identificador, se debe usar el paso de crear proceso de firma. |
Nombre del documento de salida |
Nombre con el que se generará el documento firmado. |
Parámetros de salida
Salida |
Descripción |
|---|---|
Documento firmado |
Documento recuperado desde TuID con la firma aplicada. Se devuelve solo si el documento fue firmado y el proceso de firma existe; de lo contrario se muestra un mensaje de error. |
Obtener estado del proceso de firma
Esta acción permite saber el estado de un proceso de firma para confirmar si el documento fue firmado o no. Previamente se debe ejecutar la acción «Crear proceso de firma» para obtener el identificador del proceso.
Parámetros de entrada
Entrada |
Descripción |
|---|---|
ID del proceso de firma |
Requerido. Identificador único del proceso de firma. Para obtener este identificador, se debe usar el paso de crear proceso de firma. |
Parámetros de salida
Salida |
Descripción |
|---|---|
Estado del proceso |
Requerido. Texto que representa el estado del proceso de firma. Posibles valores: |
Eliminar proceso de firma
Esta acción permite eliminar un proceso de firma. Previamente se debe ejecutar la acción «Crear proceso de firma» para obtener el identificador del proceso.
Parámetros de entrada
Entrada |
Descripción |
|---|---|
ID del proceso de firma |
Requerido. Identificador único del proceso de firma. Para obtener este identificador, se debe usar el paso de crear proceso de firma. |