Lex Power Sign (versión preliminar)
Lex Persona es un proveedor europeo de servicios de confianza cualificado que ofrece una variedad de soluciones de firma electrónica. Con Lex Enterprise, tiene acceso a todos los niveles de firma de eIDAS, junto con un gran número de métodos de autenticación del firmante. Los libros de firmas se insertan en flujos de trabajo digitales. Automatice las conexiones entre Lex Enterprise y todas las herramientas para eliminar tareas repetitivas, obtener eficacia y acelerar su negocio.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Lex Persona |
| URL | https://support.lex-persona.com |
| Correo Electrónico | support@lex-persona.com |
| Metadatos del conector | |
|---|---|
| Publicador | Lex Persona |
| Sitio web | https://www.lex-persona.com |
| Directiva de privacidad | https://www.lex-persona.com/politique-de-confidentialite/ |
| Categorías | IA; Sitio web |
Lex Persona es un proveedor de servicios de confianza cualificado europeo que ofrece una variedad de soluciones de firma electrónica. Con este conector, puede agregar fácilmente la funcionalidad de firma electrónica a la aplicación basada en Microsoft (PowerApp, aplicación web basada en .NET, Dynamics...) y entorno (Outlook, Sharepoint, Teams...). El conector está respaldado por nuestro administrador de flujos de trabajo de Lex Enterprise. Puede crear flujos de trabajo de firma electronc compuestos de diferentes tipos de pasos que se pueden ejecutar en secuencia o en paralelo. El conector admite todos los niveles de firma de eIDAS y ofrece una amplia gama de métodos de autenticación del firmante (OTP, SSO, France Connect, Identité Numérique La Poste, tokens de hardware...)
Prerrequisitos
Deberá tener lo siguiente para continuar:
- Suscripción a Lex Enterprise. Uso del plan de prueba para probar
Los requisitos del entorno son:
- Un plan de Microsoft Power Apps o Power Automate con una característica de conector personalizada
- Herramientas de la CLI de Power Platform
Obtención de credenciales
Póngase en contacto con nuestros representantes de ventas para commercial@lex-persona.com obtener una suscripción a Lex Enteprise o una cuenta en nuestros sistemas de prueba.
Conéctese al portal de Lex Enterprise con su cuenta y genere una clave de API.
Introducción al conector
En primer lugar, cree una conexión para el conector. Establezca el método de autenticación en clave de API, proporcione la clave de API ("Bearer act_XXXXXXX") y especifique que la clave de API debe colocarse en el encabezado Autrorization de las llamadas API.
Los pasos para crear un flujo de trabajo de firma simple son los siguientes:
- justo después del tigger, recupere el identificador de usuario de Lex Enterprise conectado (este identificador es necesario para crear un flujo de trabajo) con la acción Recuperarme .
- buscar páginas de consentimiento con las páginas de consentimiento de búsqueda action_. Puede usar el parámetro text para buscar páginas de consentimiento por nombre (las páginas de consentimiento definen el nivel de firma y están preconfigurados en el entorno de Lex Enterprise).
- cree un flujo de trabajo de firma con la acción Crear flujo de trabajo . En este paso, debe proporcionar información de los firmantes.
- buscar perfiles de firma con la acción Buscar perfiles de firma. Puede usar el parámetro text para buscar perfiles de firma por nombre (los perfiles de firma controlan algunos aspectos del comportamiento de las páginas de consentimiento. Forzar al firmante a desplazarse hasta la parte inferior del documento antes de firmar por ejemplo)
- Recuperar un documento de su entorno (Sharepoint, Outlook, OneDrive...)
- agregue el documento al flujo de trabajo con la acción Crear elemento y establezca el parámetro createDocument en true.
- inicie el flujo de trabajo con la acción Actualizar flujo de trabajo y establezca el estado del flujo de trabajo en iniciado.
Tenga en cuenta lo siguiente: El conector está emparejado con nuestro servidor de prueba de forma predeterminada. Si desea emparejar el conector con su propio inquilino, debe cambiar la dirección URL del host en la definición de seguridad del conector o en el archivo apiDefinitions.json:
- "host": "yourtenant.lexpersona.com",
Conocer problemas y limitaciones
La acción Crear documento acepta una lista de elementos de documento int su carga. Sin embargo, si proporciona varias partes, solo se tendrá en cuenta la primera (esto se debe a un error en nuestra API. Se corregirá en la próxima versión del conector).
Por lo tanto, si desea agregar varios documentos a un flujo de trabajo, es necesario realizar una llamada a Create part con el parámetro createDocument establecido en true para cada documento.
Errores y soluciones comunes
En caso de error de llamada API, la respuesta de llamada API contiene un mensaje de error completo que se muestra en el historial de ejecución del conector. El mensaje también contiene un identificador de registro para que, si necesita más información sobre el error, puede conectarse al portal de Lex Enteprise y consultar el archivo de registro del servidor. Alternativley, puede configurar una solicitud de Postman para buscar en nuestros registros de servidores (plase consulte la documentación: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Los códigos de error HTTP más comunes devueltos por nuestra API son los siguientes:
- Error 400: solicitud incorrecta. Hay algo incorrecto en su solicitud paylod. Consulte el registro para encontrar información sobre la causa del error.
- Error 401: no autorizado. Yo no tiene los derechos de acceso para realizar esta operación. Comprobación de los derechos de acceso de usuario de Lex Persona
- Error 403: Prohibido. La clave de API está invlaid o deshabilitada
- Error 404: no encontrado. Hay un error en la dirección URL de la solicitud.
También puede consultar nuestra documentación para obtener más detalles sobre cada llamada API posibles códigos de error (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
Preguntas más frecuentes
¿Cuáles son los formatos de documentos compatibles con el conector?
Los documentos que puede enviar para la firma pueden tener los formatos pdf, docx, pptx y xlsx. El conector convertirá los documentos en pdf si es necesario y las firmas tendrán el formato PAdES.
También es posible firmar documentos XML. En este caso, no se aplicará ninguna conversión y las firmas tendrán el formato XAdES.
También es posible cargar archivos ZIP. El conector descomprime el archivo y agrega cada documento al flujo de trabajo.
También puede agregar datos adjuntos a flujos de trabajo de firmas. Los datos adjuntos no están firmados y pueden tener cualquier formato.
¿Puede un documento tener varios firmantes?
Sí. El número de firmantes de un documento es ilimitado.
¿Es posible firmar varios documentos a la vez?
Sí. Puede agregar varios documentos a un flujo de trabajo y todos los documentos se firmarán simultáneamente. Sin embargo, tenga en cuenta que, en este caso, el conjunto de documentos se vinculará jurídicamente y que el sistema generará un archivo de pruebas único.
También puede crear mutlpiple workglows coantaining el mismo firmante. En el momento de la firma, se presentará la lista de documentos al firmante y el firmante tendrá la oportunidad de seleccionar los documentos que firma para firmar. En este caso, los documentos serán jurídicamente independientes, se generará un archivo de pruebas para cada documento.
¿Es posible firmar un documento sin conexión?
No. Se necesita una conexión intenet para acceder a las páginas de consentimiento.
¿Es posible enviar remiders automáticos de firmas a los firmantes?
Sí. Puede configurar el período de recordatorio y el número máximo de recordatorios que se van a enviar.
¿Es posible modificar un flujo de trabajo de firma ya iniciado?
Sí. Antes de cualquier firma, puede modificar cualquier cosa en el flujo de trabajo. Después de la primera firma, es imposible modificar los documentos, pero todavía puede modificar los pasos de flujo de trabajo.
¿Cuál es la duración de validez de las contraseñas de una sola vez?
La duración de validez de contraseñas únicas es de dos minutos (se muestra un countdow en las páginas de consentimiento).
Es posible comprobar la validez de una firma electrónica
Puede usar el panel Firmas de Adobe Acrobat para comprobar la validez de las firmas contenidas en un documento pdf. Como alternativa, puede usar un servicio web de validación de firmas de confianza (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation por ejemplo)
¿Cuáles son las condiciones de almacenamiento del documento Lex Persona?
De forma predeterminada, conservamos los documentos que evidencian los archivos en nuestros servidores. Tou puede buscar y descargar documentos en cualquier momento. Si se solicita, podemos eliminar los documentos de nuestros servidores de forma priódica.
¿Lex Persona conserva los tokens de marcas de tiempo?
No. No conservamos los tokens de marcas de tiempo. Si es necesario, puede agregar estos tokens a los documentos firmados.
¿Hay un período de retirada para un documento firmado?
Sí. La retirada de la solicitud depende de las condiciones legales que se aplican al documento.
¿Es posible cancelar un flujo de trabajo de firma?
Sí. Un usuario authoriezd puede cancelar un flujo de trabajo de firma iniciado en cualquier momento. No se producirá ningún archivo de desalojamiento y, si el documento ya estaba firmado por uno o varios firmantes, se anularán las sgnatures.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de API | securestring | La clave de API de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de flujo de trabajo |
Actualización de un flujo de trabajo |
| Actualización del diseño de metadatos |
Actualizar un diseño de metadatos |
| Actualizar contacto |
Modificación de una información de contacto existente |
| Actualizar documento |
Actualizar un documento |
| Actualizar el perfil de firma |
Actualización de un perfil de firma |
| Buscar contactos |
Buscar contactos |
| Buscar documentos |
Buscar documentos |
| Creación de un perfil de firma |
Creación de un perfil de firma |
| Creación del flujo de trabajo |
Creación de un flujo de trabajo |
| Crear contacto |
Agregar un contacto a la lista de contactos del usuario actual |
| Crear diseño de metadatos |
Creación de un diseño de metadatos |
| Crear documento |
Crear un documento a partir de elementos creados previamente |
| Crear elemento |
Crear un elemento de documento |
| Descarga de documentos de flujo de trabajo |
Descarga de los documentos de flujo de trabajo |
| Descarga del archivo de evidencias |
Descarga del archivo de evidencias de flujo de trabajo |
| Diseños de metadatos de búsqueda |
Diseños de flujo de trabajo de búsqueda |
| Eliminar contacto |
Quitar contacto de la lista de contects del usuario actual |
| Eliminar documento |
Eliminar un documento |
| Eliminar flujo de trabajo |
Eliminar un flujo de trabajo |
| Flujos de trabajo de búsqueda |
Flujos de trabajo de búsqueda |
| Perfiles de firma de búsqueda |
Perfiles de firma de búsqueda |
| Páginas de consentimiento de búsqueda |
Páginas de consentimiento de búsqueda |
| Recuperación de la asignación de metadatos |
Recuperación de la asignación de metadatos del inquilino especificado |
| Recuperación de la dirección URL de la página constent |
Crear y recuperar la dirección URL de la página de consentimiento de un destinatario |
| Recuperación del diseño de metadatos |
Recuperación de un diseño de flujo de trabajo |
| Recuperación del flujo de trabajo |
Recuperación del flujo de trabajo del identificador de flujo de trabajo |
| Recuperación del perfil de firma |
Recuperación de un perfil de firma |
| Recuperar contacto |
Recuperar información de contacto del identificador de contacto |
| Recuperar documento |
Recuperar un documento |
| Recuperar página de consentimiento |
Recuperar información de la página de consentimiento del identificador de la página de consentimiento |
| Recuperarme |
Recuperación del identificador de usuario conectado |
Actualización de flujo de trabajo
Actualización de un flujo de trabajo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Identificador del flujo de trabajo que se va a actualizar |
|
Tipo de contenido
|
Content-Type | string |
Tipo de contenido |
|
|
ID de usuario
|
userId | string |
Identificador del propietario del flujo de trabajo |
|
|
Nombre
|
name | string |
Nombre del flujo de trabajo |
|
|
Description
|
description | string |
Descripción del flujo de trabajo |
|
|
id
|
id | string |
id. de paso |
|
|
stepType
|
stepType | string |
firma o aprobación |
|
|
consentPageId
|
consentPageId | True | string |
Identificador de la página de consentimiento (nivel de firma) asociada a este destinatario |
|
Correo electrónico
|
True | string |
Correo electrónico del destinatario |
|
|
userId
|
userId | string |
hacer referencia a un usuario le en lugar de crear un destinatario sobre la marcha |
|
|
número de teléfono
|
phoneNumber | string |
Número de teléfono celular de reicpient |
|
|
firstName
|
firstName | string |
Nombre del destinatario |
|
|
lastName
|
lastName | string |
apellidos del destinatario |
|
|
country
|
country | string |
Código de país del destinatario |
|
|
preferredLocale
|
preferredLocale | string |
Código de configuración regional del destinatario |
|
|
organizationId
|
organizationId | string |
Id. de la organización LE del destinatario |
|
|
requiredRecipients
|
requiredRecipients | number |
número mínimo de firmantes que deben firmar para realizar el siguiente paso |
|
|
validityPeriod
|
validityPeriod | number |
duración de la validez del paso |
|
|
inviteperiod
|
inviteperiod | number |
frecuencia de recordatorios de firma |
|
|
maxInvites
|
maxInvites | number |
número máximo de recordatorios de firma |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
controla la entrega del documento firmado a los firmantes |
|
|
allowComments
|
allowComments | boolean |
permite o prohíbe comentarios en este paso |
|
|
hideAttachments
|
hideAttachments | boolean |
controla la presentación de datos adjuntos en los firmantes |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
controla la presentación de otros firmantes en el firmante |
|
|
Eventos notificados
|
notifiedEvents | array of string |
Eventos de flujo de trabajo notificados |
|
|
userId
|
userId | string |
Identificador de usuario del monitor |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Eventos de flujo de trabajo que se notificarán a este monitor |
|
|
Correo electrónico
|
string |
Correo electrónico |
||
|
Estado del flujo de trabajo
|
workflowStatus | string |
Estado actual del flujo de trabajo |
|
|
data1
|
data1 | string |
primeros metadatos |
|
|
data2
|
data2 | string |
segundo metadatos |
|
|
data3
|
data3 | string |
tercer metadatos |
|
|
data4
|
data4 | string |
cuarto metadatos |
|
|
data5
|
data5 | string |
quintos metadatos |
|
|
data6
|
data6 | string |
sexto metadatos |
|
|
data7
|
data7 | string |
séptimo metadatos |
|
|
data8
|
data8 | string |
metadatos heighth |
Devoluciones
- Body
- workflow
Actualización del diseño de metadatos
Actualizar un diseño de metadatos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de inquilino
|
layoutId | True | string |
Identificador del diseño |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Nombre
|
name | True | string |
El nombre del diseño |
|
Está deshabilitado
|
isDisabled | boolean |
Si se establece en true, el diseño se deshabilitará. |
|
|
ranura
|
slot | string |
Elemento de metadatos (datos1 a datos8) |
|
|
predeterminado
|
default | string |
Valor predeterminado de metadatos en este diseño |
|
|
opcional
|
optional | boolean |
Si es true, proporcionar un valor no es obligatorio |
|
|
Solo lectura
|
readonly | boolean |
Se puede invalidar el valor |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Si se establece en true, el valor persiste entre flujos de trabajo. |
Devoluciones
Diseño de metadatos
- Body
- layout
Actualizar contacto
Modificación de una información de contacto existente
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contactId | True | string |
Identificador del contacto |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Correo electrónico del contacto
|
string |
Correo electrónico del contacto |
||
|
Número de teléfono del contacto
|
phoneNumber | string |
Número de teléfono del contacto |
|
|
Nombre del contacto
|
firstName | string |
Nombre del contacto |
|
|
Apellidos del contacto
|
lastName | string |
Apellidos del contacto |
|
|
País del contacto
|
country | string |
País del contacto |
Devoluciones
- Body
- contact
Actualizar documento
Actualizar un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. del documento |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
signatureProfileId
|
signatureProfileId | string |
Perfil de firma que se va a aply a este documento |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Devoluciones
- Body
- document
Actualizar el perfil de firma
Actualización de un perfil de firma
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de perfil de firma
|
spId | True | string |
Identificador del perfil de firma |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Es el valor predeterminado
|
isDefault | string |
Convierte este perfil de firma en el predeterminado |
|
|
Está deshabilitado
|
isDisabled | string |
Deshabilitar este perfil de firma |
|
|
Nombre
|
name | string |
Nombre del perfil de firma |
|
|
Tipo de firma
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
Forzar el desplazamiento a la parte inferior del documento
|
forceScrollDocument | boolean |
Forzar que el firmante se desplace hasta la parte inferior del documento |
|
|
Modo de firma visible
|
pdfVisibleSignatureMode | string |
Modo de firma visible (permitido, deshabilitado, noImage) |
|
|
Texto de firma
|
pdfSignatureImageText | string |
Texto que se muestra en los paneles de firmas |
|
|
Color del texto de firma
|
pdfSignatureImageTextColor | string |
Color del texto que se muestra en los paneles de singaturas |
|
|
Tamaño de texto de firma
|
pdfSignatureImageTextSize | number |
Tamaño del texto que se muestra en los paneles de singaturas |
Devoluciones
- Body
- signatureProfile
Buscar contactos
Buscar contactos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Buscar texto
|
text | string |
Buscar por texto |
|
|
Buscar correo electrónico
|
items.email | string |
Buscar por correo electrónico |
|
|
Buscar número de teléfono
|
items.phoneNumber | string |
Buscar por número de teléfono |
|
|
Buscar nombre
|
items.fisrtName | string |
Buscar por nombre |
|
|
Buscar apellidos
|
items.lastName | string |
Buscar por apellido |
|
|
País de búsqueda
|
items.country | string |
Buscar por país |
|
|
Artículos por página
|
itemsPerPage | number |
Número de elementos por página en la respuesta |
|
|
Índice de página
|
pageIndex | number |
Índice de la página devuelta |
Devoluciones
- Body
- contacts
Buscar documentos
Buscar documentos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Buscar texto
|
text | string |
Buscar texto |
|
|
Diseño de metadatos de búsqueda
|
items.layoutId | string |
Buscar por diseño de metadatos |
|
|
Grupo de búsqueda
|
items.groupId | string |
Buscar por grupo de usuarios |
|
|
Buscar usuario
|
items.userId | string |
Buscar por propietario |
|
|
Id. de flujo de trabajo de búsqueda
|
items.workflowId | string |
Buscar por identificador de flujo de trabajo |
|
|
Nombre del flujo de trabajo de búsqueda
|
items.workflowName | string |
Buscar por nombre de flujo de trabajo |
|
|
Metadatos de búsqueda 1
|
items.data1 | string |
Buscar por valor de metadatos 1 |
|
|
Metadatos de búsqueda 2
|
items.data2 | string |
Buscar por valor de metadatos 2 |
|
|
Metadatos de búsqueda 3
|
items.data3 | string |
Buscar por valor de metadatos 3 |
|
|
Metadatos de búsqueda 4
|
items.data4 | string |
Buscar por valor de metadatos 4 |
|
|
Metadatos de búsqueda 5
|
items.data5 | string |
Buscar por valor de metadatos 5 |
|
|
Metadatos de búsqueda 6
|
items.data6 | string |
Buscar por valor de metadatos 6 |
|
|
Metadatos de búsqueda 7
|
items.data7 | string |
Buscar por valor de metadatos 7 |
|
|
Metadatos de búsqueda 8
|
items.data8 | string |
Buscar por valor de metadatos 8 |
|
|
Perfil de firma de búsqueda
|
items.signatureProfileId | string |
Buscar por perfil de firma |
|
|
Fecha de creación de la búsqueda
|
items.created | string |
Buscar por fecha de creación |
|
|
Fecha de actualización de búsqueda
|
items.updated | string |
Buscar por última fecha de actualización |
|
|
Ordenar por
|
sortBy | string |
Campo usado para ordenar el resultado de la búsqueda |
|
|
Criterio de ordenación
|
sortOrder | string |
Dirección de la ordenación |
|
|
Artículos por página
|
itemsPerPage | string |
Número de elementos por página en la respuesta |
|
|
Índice de página
|
pageIndex | string |
Índice de la página devuelta |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | documents |
Creación de un perfil de firma
Creación de un perfil de firma
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de inquilino
|
tenantId | True | string |
Identificador del inquilino |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Es el valor predeterminado
|
isDefault | True | string |
Convierte este perfil de firma en el predeterminado |
|
Está deshabilitado
|
isDisabled | string |
Deshabilitar este perfil de firma |
|
|
Nombre
|
name | True | string |
Nombre del perfil de firma |
|
Tipo documento
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, otros |
|
Tipo de firma
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
Forzar el desplazamiento a la parte inferior del documento
|
forceScrollDocument | True | boolean |
Forzar que el firmante se desplace hasta la parte inferior del documento |
|
Modo de firma visible
|
pdfVisibleSignatureMode | string |
Modo de firma visible (permitido, deshabilitado, noImage) |
|
|
Texto de firma
|
pdfSignatureImageText | string |
Texto que se muestra en los paneles de firmas |
|
|
Color del texto de firma
|
pdfSignatureImageTextColor | string |
Color del texto que se muestra en los paneles de singaturas |
|
|
Tamaño de texto de firma
|
pdfSignatureImageTextSize | number |
Tamaño del texto que se muestra en los paneles de singaturas |
Devoluciones
- Body
- signatureProfile
Creación del flujo de trabajo
Creación de un flujo de trabajo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de usuario
|
userId | True | string |
Identificador de usuario del propietario del flujo de trabajo |
|
Tipo de contenido
|
Content-Type | string |
Tipo de contenido |
|
|
Nombre
|
name | True | string |
Nombre del flujo de trabajo |
|
Description
|
description | string |
Descripción del flujo de trabajo |
|
|
id
|
id | string |
id. de paso |
|
|
stepType
|
stepType | string |
firma o aprobación |
|
|
consentPageId
|
consentPageId | True | string |
Identificador de la página de consentimiento (nivel de firma) asociada a este destinatario |
|
Correo electrónico
|
True | string |
Correo electrónico del destinatario |
|
|
userId
|
userId | string |
hacer referencia a un usuario le en lugar de crear un destinatario sobre la marcha |
|
|
número de teléfono
|
phoneNumber | string |
Número de teléfono celular de reicpient |
|
|
firstName
|
firstName | string |
Nombre del destinatario |
|
|
lastName
|
lastName | string |
apellidos del destinatario |
|
|
country
|
country | string |
Código de país del destinatario |
|
|
preferredLocale
|
preferredLocale | string |
Código de configuración regional del destinatario |
|
|
organizationId
|
organizationId | string |
Id. de la organización LE del destinatario |
|
|
requiredRecipients
|
requiredRecipients | number |
número mínimo de firmantes que deben firmar para realizar el siguiente paso |
|
|
validityPeriod
|
validityPeriod | number |
duración de la validez del paso |
|
|
inviteperiod
|
inviteperiod | number |
frecuencia de recordatorios de firma |
|
|
maxInvites
|
maxInvites | number |
número máximo de recordatorios de firma |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
controla la entrega del documento firmado a los firmantes |
|
|
allowComments
|
allowComments | boolean |
permite o prohíbe comentarios en este paso |
|
|
hideAttachments
|
hideAttachments | boolean |
controla la presentación de datos adjuntos en los firmantes |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
controla la presentación de otros firmantes en el firmante |
|
|
Eventos notificados
|
notifiedEvents | array of string |
Eventos de flujo de trabajo notificados |
|
|
userId
|
userId | string |
Identificador de usuario del monitor |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Eventos de flujo de trabajo que se notificarán a este monitor |
|
|
Correo electrónico
|
string |
Correo electrónico del monitor |
||
|
ID de plantilla
|
templateId | string |
Identificador de la plantilla de la que deriva el flujo de trabajo |
|
|
Id. de diseño
|
layoutId | string |
Diseño de metadatos usado por worklow |
|
|
data1
|
data1 | string |
Primeros metadatos |
|
|
data2
|
data2 | string |
Segundo metadatos |
|
|
data3
|
data3 | string |
Tercer metadatos |
|
|
data4
|
data4 | string |
Cuarto metadatos |
|
|
data5
|
data5 | string |
Quinto metadatos |
|
|
data6
|
data6 | string |
Sexto metadatos |
|
|
data7
|
data7 | string |
Séptimo metadatos |
|
|
data8
|
data8 | string |
Metadatos de Heighth |
Devoluciones
- Body
- workflow
Crear contacto
Agregar un contacto a la lista de contactos del usuario actual
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de usuario
|
userId | True | string |
Usuario al que pertenece el contacto |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Correo electrónico de contacto
|
True | string |
Correo electrónico de contacto |
|
|
Número de teléfono contatct
|
phoneNumber | string |
número de teléfono |
|
|
Nombre del contacto
|
firstName | True | string |
firstName |
|
Apellidos de contacto
|
lastName | True | string |
lastName |
|
País de contacto
|
country | string |
country |
Devoluciones
- Body
- contact
Crear diseño de metadatos
Creación de un diseño de metadatos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de inquilino
|
tenantId | True | string |
Identificador del diseño |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Nombre
|
name | True | string |
El nombre del diseño |
|
Está deshabilitado
|
isDisabled | boolean |
Si se establece en true, el diseño se deshabilitará. |
|
|
ranura
|
slot | string |
Elemento de metadatos (datos1 a datos8) |
|
|
predeterminado
|
default | string |
Valor predeterminado de metadatos en este diseño |
|
|
opcional
|
optional | boolean |
Si es true, proporcionar un valor no es obligatorio |
|
|
Solo lectura
|
readonly | boolean |
Se puede invalidar el valor |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Si se establece en true, el valor persiste entre flujos de trabajo. |
Devoluciones
Diseño de metadatos
- Body
- layout
Crear documento
Crear un documento a partir de elementos creados previamente
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Id. del flujo de trabajo afectado |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
tipo de contenido
|
contentType | string |
tipo de contenido |
|
|
filename
|
filename | string |
filename |
|
|
hash
|
hash | string |
hash |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Perfil de firma de este documento |
Devoluciones
- Body
- document
Crear elemento
Crear un elemento de documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Id. del flujo de trabajo afectado |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Disposición de cotent
|
Content-Disposition | True | string |
Dispotion de contenido |
|
Crear documento
|
createDocuments | string |
Creación de un documento a partir de este elemento |
|
|
Omitir datos adjuntos
|
ignoreAttachments | string |
Los datos adjuntos se omitirán |
|
|
Identificador de perfil de firma
|
signatureProfileId | string |
Parte considerada como datos adjuntos si se omite |
|
|
Descomprimir
|
unzip | string |
Descomprimir archivos |
|
|
Pdf a PdfA
|
pdf2pdfa | string |
Convertir pdf a pdf/A |
|
|
Documento
|
document | True | binary |
Datos de archivo cargados |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of document |
Documentos creados |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
partes
|
parts | array of part |
partes |
Descarga de documentos de flujo de trabajo
Descarga de los documentos de flujo de trabajo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Identificador del flujo de trabajo |
Devoluciones
- response
- binary
Descarga del archivo de evidencias
Descarga del archivo de evidencias de flujo de trabajo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Identificador del flujo de trabajo |
|
Aceptar
|
Accept | True | string |
Aceptar |
Devoluciones
- response
- binary
Diseños de metadatos de búsqueda
Diseños de flujo de trabajo de búsqueda
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Buscar texto
|
text | string |
Buscar texto |
|
|
Búsqueda deshabilitada
|
items.isDisabled | string |
Búsqueda de diseños deshabilitados |
|
|
Buscar nombre
|
items.name | string |
Buscar por nombre de diseño |
|
|
Metadatos de búsqueda
|
items.dataConfigurations.slot | string |
Búsqueda por presencia de metadatos |
|
|
Fecha de creación de la búsqueda
|
items.created | string |
Buscar por fecha de creación |
|
|
Fecha de actualización de búsqueda
|
items.updated | string |
Buscar por última fecha de actualización |
|
|
Ordenar por
|
sortBy | string |
Campo usado para ordenar el resultado de la búsqueda |
|
|
Criterio de ordenación
|
sortOrder | string |
Dirección de la ordenación |
|
|
Artículos por página
|
itemsPerPage | string |
Número de elementos por página en la respuesta |
|
|
Índice de página
|
pageIndex | string |
Índice de la página devuelta |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | layouts |
Eliminar contacto
Quitar contacto de la lista de contects del usuario actual
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contactId | True | string |
Identificador del contacto |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
Devoluciones
- Body
- contact
Eliminar documento
Eliminar un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. del documento |
Devoluciones
- Body
- document
Eliminar flujo de trabajo
Eliminar un flujo de trabajo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Identificador del flujo de trabajo que se va a eliminar |
Devoluciones
- Body
- workflow
Flujos de trabajo de búsqueda
Flujos de trabajo de búsqueda
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Aceptar
|
Accept | string |
Aceptar |
|
|
Buscar texto
|
text | string |
Buscar texto |
|
|
Diseño de metadatos de búsqueda
|
items.layoutId | string |
Buscar por diseño de metadatos |
|
|
Plantilla de búsqueda
|
items.templateId | string |
Buscar por plantilla de flujo de trabajo |
|
|
Grupo de búsqueda
|
items.groupId | string |
Buscar por grupo de usuarios |
|
|
Buscar usuario
|
items.userId | string |
Buscar por propietario |
|
|
Buscar correo electrónico
|
items.email | string |
Buscar por correo electrónico del propietario |
|
|
Buscar nombre
|
items.firstname | string |
Buscar por nombre del propietario |
|
|
Buscar apellidos
|
items.lastname | string |
Buscar por apellidos del propietario |
|
|
Estado de búsqueda
|
items.workflowStatus | string |
Buscar por estado de flujo de trabajo |
|
|
Metadatos de búsqueda 1
|
items.data1 | string |
Buscar por valor de metadatos 1 |
|
|
Metadatos de búsqueda 2
|
items.data2 | string |
Buscar por valor de metadatos 2 |
|
|
Metadatos de búsqueda 3
|
items.data3 | string |
Buscar por valor de metadatos 3 |
|
|
Metadatos de búsqueda 4
|
items.data4 | string |
Buscar por valor de metadatos 4 |
|
|
Metadatos de búsqueda 5
|
items.data5 | string |
Buscar por valor de metadatos 5 |
|
|
Metadatos de búsqueda 6
|
items.data6 | string |
Buscar por valor de metadatos 6 |
|
|
Metadatos de búsqueda 7
|
items.data7 | string |
Buscar por valor de metadatos 7 |
|
|
Metadatos de búsqueda 8
|
items.data8 | string |
Buscar por valor de metadatos 8 |
|
|
Fecha de creación de la búsqueda
|
items.created | string |
Buscar por fecha de creación |
|
|
Fecha de actualización de búsqueda
|
items.updated | string |
Buscar por última fecha de actualización |
|
|
Fecha de inicio de búsqueda
|
items.started | string |
Buscar por fecha de inicio |
|
|
Ordenar por
|
sortBy | string |
Campo usado para ordenar el resultado de la búsqueda |
|
|
Criterio de ordenación
|
sortOrder | string |
Dirección de la ordenación |
|
|
Artículos por página
|
itemsPerPage | string |
Número de elementos por página en la respuesta |
|
|
Índice de página
|
pageIndex | string |
Índice de la página devuelta |
Devoluciones
- Body
- workflows
Perfiles de firma de búsqueda
Perfiles de firma de búsqueda
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Buscar texto
|
text | string |
Buscar texto |
|
|
Valor predeterminado de búsqueda
|
items.isDefault | string |
Buscar perfiles de firma predeterminados |
|
|
Búsqueda deshabilitada
|
items.isDisabled | string |
Buscar perfiles de firma deshabilitados |
|
|
Buscar nombre
|
items.name | string |
Buscar por nombre de perfil de firma |
|
|
Buscar documento. Escriba
|
items.documentType | string |
Buscar por tipo de documento |
|
|
Tipo de firma de búsqueda
|
items.signatureType | string |
Buscar por tipo de firma |
|
|
Fecha de creación de la búsqueda
|
items.created | string |
Buscar por fecha de creación |
|
|
Fecha de actualización de búsqueda
|
items.updated | string |
Buscar por última fecha de actualización |
|
|
Ordenar por
|
sortBy | string |
Campo usado para ordenar el resultado de la búsqueda |
|
|
Criterio de ordenación
|
sortOrder | string |
Dirección de la ordenación |
|
|
Artículos por página
|
itemsPerPage | string |
Número de elementos por página en la respuesta |
|
|
Índice de página
|
pageIndex | string |
Índice de la página devuelta |
Devoluciones
- Body
- signatureProfiles
Páginas de consentimiento de búsqueda
Páginas de consentimiento de búsqueda
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Buscar texto
|
text | string |
Buscar texto |
|
|
Valor predeterminado de búsqueda
|
items.isDefault | string |
Buscar la página de consentimiento predeterminada |
|
|
Búsqueda deshabilitada
|
items.isDisabled | string |
Buscar páginas de consentimiento deshabilitadas |
|
|
Buscar nombre
|
items.name | string |
Buscar por nombre de página de consentimiento |
|
|
Tipo de paso de búsqueda
|
items.stepType | string |
Tipo de búsqueda por paso |
|
|
Buscar identificador de cliente
|
items.clientId | string |
Buscar por identificador de cliente |
|
|
Fecha de creación de la búsqueda
|
items.created | string |
Buscar por fecha de creación |
|
|
Fecha de actualización de búsqueda
|
items.updated | string |
Buscar por última fecha de actualización |
|
|
Ordenar por
|
sortBy | string |
Campo en el que se va a ordenar el resultado de la búsqueda |
|
|
Criterio de ordenación
|
sortOrder | string |
Dirección de la ordenación |
|
|
Artículos por página
|
itemsPerPage | string |
Número de elementos por página en la respuesta |
|
|
Índice de página
|
pageIndex | string |
Índice de la página devuelta |
Devoluciones
- Body
- consentPages
Recuperación de la asignación de metadatos
Recuperación de la asignación de metadatos del inquilino especificado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de inquilino
|
tenantId | True | string |
Identificador del inquilino |
Devoluciones
- Body
- dataMapping
Recuperación de la dirección URL de la página constent
Crear y recuperar la dirección URL de la página de consentimiento de un destinatario
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Identificador del flujo de trabajo |
|
Correo electrónico del destinatario
|
recipientEmail | string |
Correo electrónico del destinatario afectado |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Dirección URL de la página de consentimiento para el destinatario afectado
|
inviteUrl | string |
Dirección URL de la página de consentimiento para el destinatario afectado |
Recuperación del diseño de metadatos
Recuperación de un diseño de flujo de trabajo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de diseño
|
layoutId | True | string |
Identificador del diseño |
Devoluciones
Diseño de metadatos
- Body
- layout
Recuperación del flujo de trabajo
Recuperación del flujo de trabajo del identificador de flujo de trabajo
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de flujo de trabajo
|
workflowId | True | string |
Identificador del flujo de trabajo |
Devoluciones
- Body
- workflow
Recuperación del perfil de firma
Recuperación de un perfil de firma
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de perfil de firma
|
spId | True | string |
Identificador del perfil de firma |
Devoluciones
- Body
- signatureProfile
Recuperar contacto
Recuperar información de contacto del identificador de contacto
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contactId | True | string |
Identificador del contacto |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
Devoluciones
- Body
- contact
Recuperar documento
Recuperar un documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
documentId | True | string |
Id. del documento |
Devoluciones
- Body
- document
Recuperar página de consentimiento
Recuperar información de la página de consentimiento del identificador de la página de consentimiento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de página de consentimiento
|
cpId | True | string |
Identificador de la página de consentimiento |
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
Devoluciones
- Body
- consentPage
Recuperarme
Definiciones
consentPage
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Permite el uso de organizaciones |
|
authenticateUser
|
authenticateUser | boolean |
Impone la autenticación del firmante |
|
clientId
|
clientId | string |
Identificador de cliente |
|
creado
|
created | number |
Fecha de creación |
|
emUrl
|
emUrl | string |
Dirección URL del administrador de evidencias |
|
hideDownloads
|
hideDownloads | boolean |
Los vínculos de descarga de documentos no se reproducen en páginas de consentimiento |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Oculta los códigos QR en páginas constent |
|
id
|
id | string |
Identificador de la página de consentimiento |
|
isCountryRequired
|
isCountryRequired | boolean |
Hace que el país sea obligatorio en la información de los firmantes |
|
isDisabled
|
isDisabled | boolean |
La página de consentimiento está deshabilitada |
|
logoResourceId
|
logoResourceId | string |
Identificador del recurso de logotipo de página de consentimiento |
|
nombre
|
name | string |
Nombre de la página de consentimiento |
|
primaryColor
|
primaryColor | string |
Color principal de la página de consentimiento |
|
secondaryColor
|
secondaryColor | string |
Color secundario de la página de consentimiento |
|
sharedPassphrase
|
sharedPassphrase | string |
Frase de contraseña compartida |
|
modo de firma
|
signing mode | string |
Modo de firma (local o servidor) |
|
stepType
|
stepType | string |
tipo de paso (firma o aprobación) |
|
tenantId
|
tenantId | string |
Identificador de inquilino |
|
tsaUrl
|
tsaUrl | string |
Dirección URL de la entidad de marca de tiempo |
|
Actualizado
|
updated | number |
Fecha de última modificación |
|
verifyEmail
|
verifyEmail | boolean |
Si se establece en tue, los firmantes recibirán OTP por correos electrónicos. |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Si se establece en true, los firmantes recibirán OTP por mensajes de texto. |
consentPages
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
total de elementos
|
totalItems | integer |
total de elementos |
contacto
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
country
|
country | string |
País de contacto |
|
creado
|
created | integer |
Fecha de creación del contacto |
|
Correo electrónico
|
string |
Correo electrónico de contacto |
|
|
firstName
|
firstName | string |
Póngase en contacto con firstName |
|
id
|
id | string |
Id. de contacto |
|
lastName
|
lastName | string |
Contacto con lastName |
|
nombre
|
name | string |
Nombre de contacto (nombre + apellido)) |
|
número de teléfono
|
phoneNumber | string |
Número de teléfono de contacto |
|
tenantId
|
tenantId | string |
Identificador de inquilino |
|
Actualizado
|
updated | integer |
Fecha de última modificación de contacto |
|
userId
|
userId | string |
Identificador del propietario del contacto |
contacts
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
total de elementos
|
totalItems | integer |
total de elementos |
dataMapping
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
descripción
|
data1.description | string |
Descripción de metadatos |
|
nombre
|
data1.name | string |
Nombre de metadatos |
|
pattern
|
data1.pattern | string |
Patrón de metadatos |
|
options
|
data1.options | array of object |
options |
|
value
|
data1.options.value | string |
Valor de los metadatos |
|
type
|
data1.type | string |
type |
|
descripción
|
data2.description | string |
Descripción de metadatos |
|
nombre
|
data2.name | string |
Nombre de metadatos |
|
pattern
|
data2.pattern | string |
Patrón de metadatos |
|
options
|
data2.options | array of object |
options |
|
value
|
data2.options.value | string |
Valor de los metadatos |
|
type
|
data2.type | string |
type |
|
descripción
|
data3.description | string |
Descripción de metadatos |
|
nombre
|
data3.name | string |
Nombre de metadatos |
|
pattern
|
data3.pattern | string |
Patrón de metadatos |
|
options
|
data3.options | array of object |
options |
|
value
|
data3.options.value | string |
Valor de los metadatos |
|
type
|
data3.type | string |
type |
|
descripción
|
data4.description | string |
Descripción de metadatos |
|
nombre
|
data4.name | string |
Nombre de metadatos |
|
pattern
|
data4.pattern | string |
Patrón de metadatos |
|
options
|
data4.options | array of object |
options |
|
value
|
data4.options.value | string |
Valor de los metadatos |
|
type
|
data4.type | string |
type |
|
descripción
|
data5.description | string |
Descripción de metadatos |
|
nombre
|
data5.name | string |
Nombre de metadatos |
|
pattern
|
data5.pattern | string |
Patrón de metadatos |
|
options
|
data5.options | array of object |
options |
|
value
|
data5.options.value | string |
Valor de los metadatos |
|
type
|
data5.type | string |
type |
|
descripción
|
data6.description | string |
Descripción de metadatos |
|
nombre
|
data6.name | string |
Nombre de metadatos |
|
pattern
|
data6.pattern | string |
Patrón de metadatos |
|
options
|
data6.options | array of object |
options |
|
value
|
data6.options.value | string |
Valor de los metadatos |
|
type
|
data6.type | string |
type |
|
descripción
|
data7.description | string |
Descripción de metadatos |
|
nombre
|
data7.name | string |
Metadataname |
|
pattern
|
data7.pattern | string |
Patrón de metadatos |
|
options
|
data7.options | array of object |
options |
|
value
|
data7.options.value | string |
Metadatavalue |
|
type
|
data7.type | string |
type |
|
descripción
|
data8.description | string |
Descripción de metadatos |
|
nombre
|
data8.name | string |
Nombre de metadatos |
|
pattern
|
data8.pattern | string |
Patrón de metadatos |
|
options
|
data8.options | array of object |
options |
|
value
|
data8.options.value | string |
Valor de los metadatos |
|
type
|
data8.type | string |
type |
documento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
creado
|
created | integer |
Fecha de creación |
|
groupId
|
groupId | string |
Identificador del grupo del propietario del documento |
|
id
|
id | string |
Id. del documento |
|
partes
|
parts | array of part |
partes |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
Identificador del perfil de firma del documento |
|
tenantId
|
tenantId | string |
Id. de inquilino |
|
Actualizado
|
updated | integer |
Fecha de última modificación |
|
userId
|
userId | string |
Identificador de usuario del propietario del documento |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupos permitidos para ver el documento |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Lista de usuarios permitidos para ver el documento |
|
workflowId
|
workflowId | string |
Identificador del flujo de trabajo al que pertenece el documento |
|
workflowName
|
workflowName | string |
Nombre del flujo de trabajo al que pertenece el documento |
Documentos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
total de elementos
|
totalItems | integer |
total de elementos |
diseño
Diseño de metadatos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
creado
|
created | number |
Fecha de creación |
|
id
|
id | string |
Id. de diseño |
|
isDisabled
|
isDisabled | boolean |
Si se establece en true, el diseño se ha desbasblado |
|
nombre
|
name | string |
Nombre del diseño |
|
tenantId
|
tenantId | string |
Identificador del inquilino |
|
Actualizado
|
updated | number |
Fecha de última modificación |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
ranura
|
dataConfigurations.slot | string |
Elemento de metadatos (datos1 a datos8) |
|
predeterminado
|
dataConfigurations.default | string |
Valor predeterminado de metadatos en este diseño |
|
opcional
|
dataConfigurations.optional | boolean |
Si es true, proporcionar un valor para estos metadatos no es obligatorio |
|
Solo lectura
|
dataConfigurations.readonly | boolean |
Se puede invalidar el valor |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Si se establece en true, el valor persiste entre flujos de trabajo. |
Diseños
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
creado
|
items.created | number |
Fecha de creación |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Número de elementos por página |
|
pageIndex
|
pageIndex | number |
Índice de la página devuelta |
|
total de elementos
|
totalItems | number |
Número total de elementos afectados por la solicitud |
part
Elemento de documento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
tipo de contenido
|
contentType | string |
tipo de contenido |
|
filename
|
filename | string |
filename |
|
hash
|
hash | string |
hash |
|
size
|
size | integer |
size |
pdfSigField
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
creado
|
created | number |
Fecha de creación |
|
documentType
|
documentType | string |
Tipo de los documentos |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Forzar que el firmante se desplace hasta la parte inferior del documento |
|
id
|
id | string |
el identificador del perfil de firma |
|
isDefault
|
isDefault | boolean |
Convierte este perfil de firma en el predeterminado |
|
isDisabled
|
isDisabled | boolean |
Deshabilitar este perfil de firma |
|
nombre
|
name | string |
Nombre del perfil de firma |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Texto que se muestra en los paneles de firmas |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Color del texto que se muestra en los paneles de singaturas |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Tamaño del texto que se muestra en los paneles de singaturas |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Modo de firma visible (permitido, deshabilitado, noImage) |
|
Tipo de firma
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
Identificador de inquilino |
|
Actualizado
|
updated | number |
Fecha de última modificación |
signatureProfiles
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Número de elementos por página |
|
pageIndex
|
pageIndex | number |
Índice de la página devuelta |
|
total de elementos
|
totalItems | number |
Número total de elementos afectados por la solicitud |
user
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
Si se establece en true, el usuario puede aprobar documentos |
|
country
|
country | string |
País del usuario |
|
creado
|
created | integer |
Fecha de creación |
|
Correo electrónico
|
string |
Correo electrónico del usuario |
|
|
firstName
|
firstName | string |
FirstName del usuario |
|
groupId
|
groupId | string |
Identificador del grupo del usuario |
|
id
|
id | string |
Id del usuario |
|
isDisabled
|
isDisabled | boolean |
Si es true, el usuario está deshabilitado |
|
lastLogin
|
lastLogin | integer |
Fecha de último inicio de sesión del usuario |
|
lastName
|
lastName | string |
LastName del usuario |
|
nombre
|
name | string |
Nombre (nombre + apellidos) del usuario |
|
organizationTitles
|
organizationTitles | array of |
Las diversión del usuario en sus organizaciones |
|
número de teléfono
|
phoneNumber | string |
Número de teléfono del usuario |
|
signAllowed
|
signAllowed | boolean |
Si se establece en true, el usuario puede firmar documentos. |
|
Asunto
|
subject | string |
Código de subkect interno del usuario |
|
tenantId
|
tenantId | string |
Identificador del inquilino |
|
Actualizado
|
updated | integer |
Fecha de última modificación |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupos en los que el usuario puede actuar como observador |
flujo de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
creado
|
created | integer |
creado |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Metadatos 1 |
|
data2
|
data2 | string |
Metadatos 2 |
|
data3
|
data3 | string |
Metadatos 3 |
|
data4
|
data4 | string |
Metadatos 4 |
|
data5
|
data5 | string |
Metadatos 5 |
|
data6
|
data6 | string |
Metadatos 6 |
|
data7
|
data7 | string |
Metadatos 7 |
|
data8
|
data8 | string |
Metadatos 8 |
|
descripción
|
description | string |
Descripción del flujo de trabajo |
|
Correo electrónico
|
string |
Correo electrónico del propietario del flujo de trabajo |
|
|
firstName
|
firstName | string |
Nombre del propietario del flujo de trabajo |
|
groupId
|
groupId | string |
Identificador del grupo del propietario del flujo de trabajo |
|
id
|
id | string |
Identificador del flujo de trabajo |
|
lastName
|
lastName | string |
Apellidos del propietario del flujo de trabajo |
|
layoutId
|
layoutId | string |
Identificador del diseño de metadatos del flujo de trabajo |
|
logs
|
logs | array of |
Registra elementos del wokflow |
|
nombre
|
name | string |
Nombre (nombre + apellido) del propietario del flujo de trabajo |
|
notifiedEvents
|
notifiedEvents | array of string |
Lis de eventos notificados por el flujo de trabajo |
|
progreso
|
progress | integer |
Progreso del flujo de trabajo en porcentajes |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Permite o prohíbe comentarios interactivos permitidos en el paso |
|
hideAttachments
|
steps.hideAttachments | boolean |
Controla la visualización de datos adjuntos a los firmantes |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Controla la presentación de otros firmantes en el firmante |
|
id
|
steps.id | string |
Id. de paso |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
isStarted
|
steps.isStarted | boolean |
isStarted |
|
logs
|
steps.logs | array of |
logs |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
destinatarios
|
steps.recipients | array of object |
destinatarios |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
Correo electrónico
|
steps.recipients.email | string |
Correo electrónico |
|
firstName
|
steps.recipients.firstName | string |
firstName |
|
lastName
|
steps.recipients.lastName | string |
lastName |
|
número de teléfono
|
steps.recipients.phoneNumber | string |
número de teléfono |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
Actualizado
|
updated | integer |
Actualizado |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupos en los que los usuarios pueden actuar como observadores |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
Correo electrónico
|
watchers.email | string |
Correo electrónico |
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
total de elementos
|
totalItems | integer |
total de elementos |
binario
Este es el tipo de datos básico "binary".