ESignatures conectivos
Connected eSignatures es una famosa solución de firma digital que ofrece una gran cantidad de métodos de firma y cumplimiento a las regulaciones nacionales más estrictas (inter)nacionales. eSignatures permite transformar cualquier proceso basado en papel en un flujo digital integral con una experiencia de usuario sin precedentes. Optimice el proceso de firma exactamente cómo desea que sea y envíe, firme y realice un seguimiento de todos los tipos de documentos directamente desde sus aplicaciones empresariales favoritas. Únase a más de 500 clientes satisfechos.
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 la conección |
| URL | https://connective.eu/contact-support/ |
| Correo Electrónico | service@connective.eu |
| Metadatos del conector | |
|---|---|
| Publicador | Conectivo |
| Sitio web | https://www.connective.eu |
| Directiva de privacidad | https://connective.eu/privacy-policy/ |
| Categorías | Operaciones de TI; Productividad |
Conección, especialista en firmas digitales, servicios de identidad y generación de documentos inteligentes, ha hecho que el conector eSignatures de Connector para Power Automate esté disponible para su uso. El conector permite a las empresas reenviar documentos que requieren una firma digital directamente desde sus aplicaciones favoritas de Microsoft 365, desde Microsoft Teams a Word, SharePoint, Dynamics, OneDrive y muchos otros.
Cómo empezar a usar el conector
Para empezar a usar el conector, póngase en contacto con su administrador de relaciones en Conectivo o vaya a nuestra página de contacto en nuestro sitio web para recibir las credenciales.
Esta página detallará aún más las diferentes acciones disponibles, así como proporcionará información sobre las distintas formas en que se pueden implementar estas acciones.
No dude en echar un vistazo a nuestro sitio web de documentación para obtener más información o ponerse en contacto con el equipo de soporte técnico a través de un formulario de contacto de soporte técnico o buzón de soporte técnico: service@connective.eu
Hay disponible un glosario para explicar los distintos términos que se usan en esta documentación.
Acciones
El conector Connector eSignatures se basa en la API v3 de eSignatures. La API eSignatures es una API REST que permite que las aplicaciones externas se integren con y usen las características enumeradas en este documento para crear y administrar flujos de firma.
Las acciones disponibles se pueden agrupar en grupos diferentes.
| Grupo de acciones | Acciones disponibles |
|---|---|
| Carga de documentos | Crear paquete |
| Agregar documento al paquete | |
| Obtener ubicaciones de firma | |
| Establecer información del proceso | |
| Establecer el estado del paquete | |
| Crear paquete instantáneo | |
| Recuperación del estado de un documento | Obtener el estado del paquete |
| Obtener lista de paquetes | |
| Acciones varias | Omitir firmantes |
| Descargar paquete | |
| Extensión de expiración del paquete | |
| Enviar recordatorio de paquete | |
| Eliminar paquete | |
| Recuperación de la prueba de auditoría | Recuperar pruebas de auditoría de paquetes |
| Recuperar pruebas de auditoría de documentos | |
| Recuperar las pruebas de auditoría de paquetes con el identificador de correlación | |
| Recuperar pruebas de auditoría de documentos con el identificador de correlación | |
| Agregar prueba desde un origen externo |
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 |
|---|---|---|---|
| Dirección URL del entorno de eSignatures | cuerda / cadena | Dirección URL al entorno de eSignatures conectivo, por ejemplo, esignatures.connective.eu | Cierto |
| Nombre de usuario de API | securestring | Nombre de usuario de la API para acceder a la API | Cierto |
| Contraseña de API | securestring | Contraseña de API para acceder a la API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Agregar documento al paquete |
Esta llamada agregará un documento a un paquete existente. |
| Agregar prueba desde un origen externo |
Esta llamada permite a los usuarios de api agregar pruebas adicionales de un origen externo a una ubicación de un documento. |
| Crear paquete |
Esta llamada crea un paquete vacío, lo que permite agregar documentos a él. |
| Crear paquete instantáneo |
Esta llamada crea un paquete con un único documento en él y lo prepara al instante para firmarlo. |
| Descarga de prueba de auditoría de correlación de documentos |
Los identificadores de correlación se usan para realizar un seguimiento de los paquetes o documentos en varios pasos a través de la aplicación eSignatures. |
| Descarga de prueba de auditoría de correlación de paquetes |
Los identificadores de correlación se usan para realizar un seguimiento de los paquetes o documentos en varios pasos a través de la aplicación eSignatures. |
| Descargar documento del paquete |
Los documentos firmados en un paquete se pueden descargar uno por uno por un sistema externo mediante esta llamada. Cada documento se descargará como PDF o como una secuencia de archivos XML, según el valor del parámetro DocumentType. |
| Descargar paquete |
Un sistema externo puede descargar el paquete que contiene los documentos firmados mediante esta llamada. |
| Eliminar paquete |
eSignatures no elimina automáticamente los paquetes de la base de datos una vez que han alcanzado un estado final. Se almacenan indefinidamente. Para eliminar paquetes de la base de datos, los usuarios pueden usar la llamada Eliminar paquete. |
| Enviar recordatorios de paquete |
La directiva de empresa puede requerir que un documento se controle dentro de un intervalo de tiempo determinado. Al desencadenar la llamada "enviar recordatorios", se buscarán todos los usuarios que no hayan firmado y les enviarán una notificación adicional como recordatorio. |
| Establecer el estado del paquete |
Por medio de la llamada Establecer estado del paquete, puede cambiar el estado de un paquete. |
| Establecer información del proceso |
Este método de servicio web actualiza las personas implicadas en el proceso (partes interesadas) y les asigna los pasos que deben realizarse. |
| Lista de paquetes |
Obtener una lista de paquetes con su estado actual |
| Marca de tiempo de expiración |
Un paquete puede tener el estado Expirado cuando un paquete pasó un valor para el parámetro ExpiryTimestamp en la llamada Crear paquete. Este paquete ya no se puede firmar. |
| Obtener el estado del paquete |
Recupera el estado actual del paquete y sus documentos. |
| Obtener ubicaciones de firma |
Esta llamada proporciona información general de todas las ubicaciones de firma dentro de los documentos dentro de un paquete. |
| Omitir firmantes |
Esta llamada omite todos los firmantes que aún no han firmado y establece su estado en "Omitido", lo que da como resultado que el paquete completo se marque como "Finalizado". |
| Prueba de auditoría de paquetes |
El xml de las pruebas de auditoría de un paquete se puede recuperar cuando el paquete está totalmente firmado. Lo mismo se aplica a un documento: solo funciona cuando el paquete contenedor está totalmente firmado. |
| Prueba de auditoría del paquete con el identificador de documento |
El xml de las pruebas de auditoría de un paquete se puede recuperar cuando el paquete está totalmente firmado. Lo mismo se aplica a un documento: solo funciona cuando el paquete contenedor está totalmente firmado. |
Agregar documento al paquete
Esta llamada agregará un documento a un paquete existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del paquete.
|
PackageId | True | string |
Id. único del paquete |
|
Documento
|
Document | string |
Documento adjunto en formato codificado en base64. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Idioma que se va a usar en textos de firma. |
|
|
DocumentName
|
DocumentName | string |
Nombre del documento que se va a mostrar en el portal de eSignatures. |
|
|
PageNumber
|
PageNumber | integer |
Número de la página en la que se va a agregar una ubicación de firma |
|
|
Ancho
|
Width | string |
Ancho |
|
|
Altura
|
Height | string |
Altura |
|
|
Left
|
Left | string |
Posición de la izquierda de la página |
|
|
Arriba
|
Top | string |
Posición desde la parte superior de la página |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Referencia única a un campo de firma, marcador de texto o campo de texto. |
|
|
CorrelationId
|
CorrelationId | string |
Identificador que indica qué documentos de este paquete están correlacionados con los documentos que se han firmado en el pasado en otros paquetes. |
|
|
DocumentType
|
DocumentType | string |
Tipo de documento que se firmará. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Referencia dada por la aplicación que realiza la llamada. |
|
|
ErrorCode
|
ErrorCode | string |
Código de error con información de variable. |
|
|
Message
|
Message | string |
Texto detallado del mensaje de error, no localizado |
|
|
Representación
|
Representation | string |
Documento de representación adjunto en formato base64. Debe ser datos PDF. |
|
|
RepresentationType
|
RepresentationType | string |
Tipo del documento de representación. |
|
|
TargetType (Tipo de destino)
|
TargetType | string |
TargetType define si es necesario realizar una conversión adicional a PDF/A antes de firmar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Identificador único del documento |
|
CreationTimestamp
|
CreationTimestamp | string |
Fecha y hora en que se creó el flujo. Formato: AAAA-MM-DDThh:mm:ss+zz:zz |
|
Ubicaciones
|
Locations | array of object |
Representa una posible ubicación para una firma. |
|
Id
|
Locations.Id | string |
Identificador único de esta ubicación |
|
Etiqueta
|
Locations.Label | string |
Etiqueta detectada o especificada |
|
PageNumber
|
Locations.PageNumber | integer |
Página en la que se encontró la ubicación. |
Agregar prueba desde un origen externo
Esta llamada permite a los usuarios de api agregar pruebas adicionales de un origen externo a una ubicación de un documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
packageId | True | string |
Identificador único del paquete |
|
Content
|
Content | string |
Contenido real de la prueba. |
|
|
LocationId
|
LocationId | string |
Ubicación de la firma para la que se generó el contenido de prueba. |
|
|
Nombre
|
Name | string |
Nombre de la prueba. |
|
|
Tipo
|
Type | string |
Clave "tipo" legible por la máquina. Se puede elegir libremente. |
|
|
Description
|
Description | string |
Breve descripción legible de la prueba. |
|
|
Dirección IP
|
IpAddress | string |
Dirección IP del usuario final del origen externo para el que se agregó la prueba. |
Crear paquete
Esta llamada crea un paquete vacío, lo que permite agregar documentos a él.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido |
|
Initiator
|
Initiator | string |
Dirección de correo electrónico de un usuario registrado. |
|
|
PackageName
|
PackageName | string |
Nombre del paquete, visto en el portal de eSignatures y al descargar como archivo ZIP. |
|
|
CallBackUrl
|
CallBackUrl | string |
Dirección URL de la API REST a la que se llamará cada vez que se haya completado una acción para este paquete. |
|
|
CorrelationId
|
CorrelationId | string |
Identificador que indica qué paquetes están correlacionados. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
El "Código" que identifica un grupo de documentos en el que se debe mostrar el paquete. |
|
|
ThemeCode
|
ThemeCode | string |
Tema que se debe aplicar al paquete |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Este parámetro determina si los paquetes se pueden descargar desde WYSIWYS antes de firmar. |
|
|
ReasignarEnabled
|
ReassignEnabled | boolean |
Este parámetro determina si los paquetes se pueden reasignar de WYSIWYS a otro aprobador o firmante. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Este parámetro determina después de cuántos días deben expirar las direcciones URL de acción cuando no se usan. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Fecha y hora en que expira este paquete y ya no se puede firmar. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Referencia dada por la aplicación que realiza la llamada. El portal de eSignatures no usará este parámetro. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Este campo está reservado para uso futuro. Se puede usar para extensiones específicas del cliente para integrarse con servicios de terceros, como la firma de tarjeta de débito. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Dirección URL a la que se redirige al usuario final después de que todos los campos se hayan firmado con la firma de "cara a cara" o cuando se hayan rechazado todos los campos. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
Dirección URL de la API REST a la que se llamará cuando un usuario final solicite recibir una notificación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificador único del paquete. |
|
CreationTimestamp
|
CreationTimestamp | string |
Fecha y hora en que se creó el paquete según el servidor. |
Crear paquete instantáneo
Esta llamada crea un paquete con un único documento en él y lo prepara al instante para firmarlo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Documento
|
Document | byte |
Documento adjunto en formato codificado en base64. Obligatorio a menos que se use el formato Multipart. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Idioma que se va a usar en textos de firma. Actualmente compatible: en, nl, de, fr, es. |
|
|
DocumentName
|
DocumentName | string |
Nombre del documento y paquete que se va a mostrar en el portal de firmas electrónicas. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
Dirección de correo electrónico de un usuario registrado |
|
|
Tipo
|
Type | string |
Firmante/Receptor |
|
|
OrderIndex
|
OrderIndex | integer |
Este número especifica en qué orden los actores deben ejecutar su acción. |
|
|
PageNumber
|
PageNumber | integer |
Número de la página en la que se va a agregar una ubicación de firma |
|
|
Ancho
|
Width | string |
Ancho |
|
|
Altura
|
Height | string |
Altura |
|
|
Left
|
Left | string |
Posición de la izquierda de la página |
|
|
Arriba
|
Top | string |
Posición desde la parte superior de la página |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Referencia única a un campo de firma, marcador de texto o campo de texto. |
|
|
SigningType
|
SigningType | string |
Tipo de firma usado en la sesión de este actor. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Uno o varios OID de tipos de compromiso. Solo se puede pasar cuando se usa la directiva de firma. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Tipo de validación que se va a ejecutar durante el eID de otra tarjeta inteligente o sesión de firma de itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Define qué eID u otras tarjetas inteligentes pueden firmar durante esta sesión. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Detalles de la directiva de firma para la firma. |
|
|
Número de teléfono
|
Phonenumber | string |
Número de teléfono para recibir un OTP sms. |
|
|
RedirectUrl
|
RedirectUrl | string |
Dirección URL a la que se redirige al usuario final después de la firma. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures puede enviar correos electrónicos a todas las personas que tienen permiso para firmar. |
|
|
UserRoles
|
UserRoles | array of string |
Rol o función del firmante. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Aviso legal |
|
|
LegalNoticeText
|
LegalNoticeText | string |
El texto del aviso legal personalizado en caso de que no se aplique ninguno de los tres avisos legales predefinidos. |
|
|
Dirección de correo electrónico
|
EmailAddress | string |
Dirección de correo electrónico |
|
|
Primer Nombre
|
FirstName | string |
Primer Nombre |
|
|
Apellido
|
LastName | string |
Apellido |
|
|
BirthDate
|
BirthDate | string |
BirthDate |
|
|
Language
|
Language | string |
Language |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
Dirección URL de la API REST a la que se llamará cada vez que se haya completado una acción para este paquete. |
|
|
CorrelationId
|
CorrelationId | string |
Identificador que indica qué paquetes o documentos están correlacionados |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
"Código" que identifica un grupo de documentos en el que se debe mostrar el documento |
|
|
ThemeCode
|
ThemeCode | string |
Tema que se debe aplicar al paquete |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Este parámetro determina si los paquetes se pueden descargar desde WYSIWYS antes de firmar. |
|
|
ReasignarEnabled
|
ReassignEnabled | boolean |
Este parámetro determina si los paquetes se pueden reasignar de WYSIWYS a otro aprobador o firmante. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Este parámetro determina después de cuántos días deben expirar las direcciones URL de acción cuando no se usan. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Referencia dada por la aplicación que realiza la llamada. El portal de eSignatures no usará este parámetro. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Referencia dada por la aplicación que realiza la llamada, el portal de eSignatures no usará este parámetro. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Referencia dada por la aplicación que realiza la llamada, el portal de eSignatures no usará este parámetro. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Dirección URL a la que se redirige al usuario final después de que todos los campos se hayan firmado con la firma de "cara a cara" o cuando se hayan rechazado todos los campos. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
Dirección URL de la API REST a la que se llamará cuando un usuario final solicite recibir una notificación. Si no se proporciona ninguna dirección URL, no se realiza ninguna devolución de llamada. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Cómo tratar con archivos PDF que contienen errores menores |
|
|
Representación
|
Representation | string |
Documento de representación adjunta en formato base64 |
|
|
RepresentationType
|
RepresentationType | string |
El tipo del documento de representación debe estar presente cuando se rellene la representación. Solo se admite "application/pdf". |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
La plantilla configurada en el portal proporcionará toda la información necesaria. |
|
|
TargetType (Tipo de destino)
|
TargetType | string |
TargetType define si es necesario realizar una conversión adicional a PDF/A antes de firmar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificador único del paquete. |
|
CreationTimestamp
|
CreationTimestamp | string |
Fecha y hora en que se creó el paquete según el servidor. |
Descarga de prueba de auditoría de correlación de documentos
Los identificadores de correlación se usan para realizar un seguimiento de los paquetes o documentos en varios pasos a través de la aplicación eSignatures.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de correlación.
|
correlationId | True | string |
Identificador de correlación. |
Devoluciones
- Body
- Content
Descarga de prueba de auditoría de correlación de paquetes
Los identificadores de correlación se usan para realizar un seguimiento de los paquetes o documentos en varios pasos a través de la aplicación eSignatures.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de correlación.
|
correlationId | True | string |
Identificador de correlación. |
Devoluciones
- Body
- Content
Descargar documento del paquete
Los documentos firmados en un paquete se pueden descargar uno por uno por un sistema externo mediante esta llamada. Cada documento se descargará como PDF o como una secuencia de archivos XML, según el valor del parámetro DocumentType.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único para el paquete de firma
|
id | True | string |
Identificador único para el paquete de firma |
|
Identificador único del documento contenido en el paquete
|
documentId | True | string |
Identificador único del documento contenido en el paquete |
Devoluciones
- response
- binary
Descargar paquete
Un sistema externo puede descargar el paquete que contiene los documentos firmados mediante esta llamada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
id | True | string |
Identificador único del paquete |
Devoluciones
- response
- binary
Eliminar paquete
eSignatures no elimina automáticamente los paquetes de la base de datos una vez que han alcanzado un estado final. Se almacenan indefinidamente. Para eliminar paquetes de la base de datos, los usuarios pueden usar la llamada Eliminar paquete.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
id | True | string |
Identificador único del paquete |
Enviar recordatorios de paquete
La directiva de empresa puede requerir que un documento se controle dentro de un intervalo de tiempo determinado. Al desencadenar la llamada "enviar recordatorios", se buscarán todos los usuarios que no hayan firmado y les enviarán una notificación adicional como recordatorio.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
PackageId | True | string |
Identificador único del paquete |
Establecer el estado del paquete
Por medio de la llamada Establecer estado del paquete, puede cambiar el estado de un paquete.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único para el paquete de firma
|
Id | True | string |
Identificador único para el paquete de firma |
|
Estado
|
Status | string |
Pendiente/Revocado |
Devoluciones
Descripción del paquete que se muestra al usuario del portal de eSignatures como nombre de archivo.
- Body
- PackageStatus
Establecer información del proceso
Este método de servicio web actualiza las personas implicadas en el proceso (partes interesadas) y les asigna los pasos que deben realizarse.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
id | True | string |
Identificador único del paquete |
|
Tipo
|
Type | string |
Tipo |
|
|
OrderIndex
|
OrderIndex | string |
Este número especifica en qué orden los actores deben ejecutar su acción. |
|
|
LocationIds
|
LocationIds | array of string |
Identificadores de ubicación donde esta persona debe colocar una firma. |
|
|
SigningType
|
SigningType | string |
Tipo de firma usado en la sesión de este actor. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Uno o varios OID de tipos de compromiso. Solo se puede pasar cuando se usa la directiva de firma. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Tipo de validación que se va a ejecutar durante el eID de otra tarjeta inteligente o sesión de firma de itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Define qué eID u otras tarjetas inteligentes pueden firmar durante esta sesión. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Detalles de la directiva de firma para la firma. |
|
|
Número de teléfono
|
Phonenumber | string |
Número de teléfono para recibir un OTP sms. |
|
|
RedirectURL
|
RedirectURL | string |
Dirección URL a la que se redirige al usuario final después de la firma o rechazando. El redireccionamiento se produce inmediatamente después de firmar o rechazar. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures puede enviar correos electrónicos a los actores cuya acción es necesaria, como la firma |
|
|
UserRoles
|
UserRoles | array of string |
Identificadores de ubicación donde esta persona debe colocar una firma. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Los 3 valores apuntarán a los 3 avisos legales integrados en la aplicación. Estos se pueden modificar en el índice de configuración. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Texto de aviso legal personalizado en caso de que no se aplique ninguno de los tres avisos legales predefinidos |
|
|
Dirección de correo electrónico
|
EmailAddress | string |
Dirección de correo electrónico |
|
|
Primer Nombre
|
FirstName | string |
Nombre |
|
|
Language
|
Language | string |
Idioma de la interfaz de usuario de esta parte interesada. Actualmente compatible: en, nl, de, fr, es. |
|
|
Apellido
|
LastName | string |
Apellido |
|
|
BirthDate
|
BirthDate | string |
Fecha de nacimiento en formato: AAAA-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Referencia dada por la aplicación que realiza la llamada. El portal de eSignatures no usará este parámetro. |
Lista de paquetes
Obtener una lista de paquetes con su estado actual
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Token o guid de continuación para saber qué página se va a devolver.
|
ContinuationToken | string |
Token o guid de continuación para saber qué página se va a devolver. DEBE ESTAR VACÍO o el token devuelto desde una llamada ANTERIOR. |
|
|
Obtiene o establece la cantidad máxima.
|
MaxQuantity | integer |
Obtiene o establece la cantidad máxima. |
|
|
Obtiene o establece el campo de ordenación.
|
SortField | string |
Obtiene o establece el campo de ordenación. |
|
|
Obtiene o establece el campo de ordenación.
|
SortOrder | string |
Obtiene o establece el campo de ordenación. |
|
|
Obtiene o establece la fecha de creación anterior.
|
CreatedBeforeDate | string |
Obtiene o establece la fecha de creación anterior. |
|
|
Obtiene o establece el estado.
|
Status | string |
Obtiene o establece el estado. |
|
|
Obtiene o establece el objeto creado después de la fecha.
|
createdAfterDate | string |
Obtiene o establece el objeto creado después de la fecha. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Token de Continuación
|
ContinuationToken | string |
Token de Continuación |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Productos
|
Items | array of Package |
Marca de tiempo de expiración
Un paquete puede tener el estado Expirado cuando un paquete pasó un valor para el parámetro ExpiryTimestamp en la llamada Crear paquete. Este paquete ya no se puede firmar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
id | True | string |
Identificador único del paquete |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Obtener el estado del paquete
Recupera el estado actual del paquete y sus documentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único para el paquete de firma
|
Id | True | string |
Identificador único para el paquete de firma |
Devoluciones
Descripción del paquete que se muestra al usuario del portal de eSignatures como nombre de archivo.
- Body
- PackageStatus
Obtener ubicaciones de firma
Esta llamada proporciona información general de todas las ubicaciones de firma dentro de los documentos dentro de un paquete.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del campo de firma
|
Id | True | string |
Identificador del campo de firma |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
Identificador único del documento |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Referencia externa para la identificación. Asegúrese de usar un valor único. |
|
Ubicaciones
|
Documents.Locations | array of object |
Representa una posible ubicación para una firma. |
|
Id
|
Documents.Locations.Id | string |
Identificador único de esta ubicación. |
|
Etiqueta
|
Documents.Locations.Label | string |
Valor que especificó como parámetro Request. |
|
PageNumber
|
Documents.Locations.PageNumber | integer |
Número de la página en la que se puede encontrar la firma. |
Omitir firmantes
Esta llamada omite todos los firmantes que aún no han firmado y establece su estado en "Omitido", lo que da como resultado que el paquete completo se marque como "Finalizado".
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
PackageId | True | string |
Identificador único del paquete |
Prueba de auditoría de paquetes
El xml de las pruebas de auditoría de un paquete se puede recuperar cuando el paquete está totalmente firmado. Lo mismo se aplica a un documento: solo funciona cuando el paquete contenedor está totalmente firmado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
packageId | True | string |
Identificador único del paquete |
Devoluciones
- Body
- Content
Prueba de auditoría del paquete con el identificador de documento
El xml de las pruebas de auditoría de un paquete se puede recuperar cuando el paquete está totalmente firmado. Lo mismo se aplica a un documento: solo funciona cuando el paquete contenedor está totalmente firmado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador único del paquete
|
packageId | True | string |
Identificador único del paquete |
|
Identificador único del documento
|
documentId | True | string |
Identificador único del documento |
Devoluciones
- Body
- Content
Definiciones
Package
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Detalles de cada uno de los documentos del paquete
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Identificador único del documento |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Devuelve la referencia externa de este documento tal como se pasó a través de la llamada agregar documento al paquete. |
|
DocumentName
|
DocumentName | string |
Nombre del documento |
|
DocumentType
|
DocumentType | string |
Tipo de documento dentro del paquete. |
PackageStatus
Descripción del paquete que se muestra al usuario del portal de eSignatures como nombre de archivo.
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Descripción del paquete que se muestra al usuario del portal de eSignatures como nombre de archivo. |
|
CreationTimestamp
|
CreationTimestamp | string |
Fecha y hora en que se creó el paquete según el servidor. |
|
Initiator
|
Initiator | string |
Campo iniciador del paquete tal como se pasó en el momento de la creación. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Hora con formato UTC en la que expira el documento. Puede ser NULL. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Devuelve el identificador de referencia externo del paquete tal como se pasó en el momento de la creación. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Vínculo al paquete que permite elegir entre todas las sesiones de firma a la vez. |
|
PackageStatus
|
PackageStatus | string |
Estado del paquete en su conjunto: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Detalles de cada uno de los documentos del paquete. |
|
Partes interesadas
|
Stakeholders | array of object |
Detalles de cada una de las personas que interactuarán con el paquete. |
|
Tipo
|
Stakeholders.Type | string |
Tipo de parte interesada: Person, PersonGroup o ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Nombre del grupo de personas. Solo se devuelve si Type se estableció en PersonGroup en la solicitud. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Código del grupo de contactos. Solo se devuelve si Type se estableció en ContactGroup en la solicitud. |
|
Dirección de correo electrónico
|
Stakeholders.EmailAddress | string |
Dirección de correo electrónico del firmante. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Referencia externa que identifica a esta persona en el sistema externo. |
|
StakeholdersId
|
Stakeholders.StakeholderId | string |
Identificador único. |
|
Actors
|
Stakeholders.Actors | array of object |
Detalles de todos los pasos que se deben realizar. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
Identificador único para esta combinación de acciones, partes interesadas y documentos. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
Dirección URL que esta persona puede abrir para interactuar con el paquete. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Matriz de direcciones URL a las que pueden abrirse las distintas personas de PersonGroup o ContactGroup para interactuar con el paquete. |
|
Dirección de correo electrónico
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Dirección de correo electrónico de la persona. |
|
URL
|
Stakeholders.Actors.ActionUrls.Url | string |
Dirección URL que esta persona puede abrir para interactuar con el paquete. |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Borrador (el paquete tiene el estado Borrador) |
|
Tipo
|
Stakeholders.Actors.Type | string |
Firmante/Receptor |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
Nombre del usuario final que completó la acción. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Marca de tiempo del momento en el que se completó esta acción. |
|
Motivo
|
Stakeholders.Actors.Reason | string |
Devuelve el texto escrito por la persona que cambió el estado de un paquete a un estado final (por ejemplo, un rechazo). |
|
Ubicaciones
|
Stakeholders.Actors.Locations | array of object |
Representa una posible ubicación para una firma. |
|
Id
|
Stakeholders.Actors.Locations.Id | string |
Identificador único de esta ubicación |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Devuelve el tipo de firma que se usó para firmar el documento. |
Content
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Fotos
|
uploads | array of object | |
|
upload
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
end
|
uploads.upload.end | date-time | |
|
Firmas
|
uploads.upload.signatures | array of object | |
|
Pruebas
|
uploads.upload.signatures.proofs | array of object | |
|
nombre
|
uploads.upload.signatures.proofs.proof.name | string | |
|
type
|
uploads.upload.signatures.proofs.proof.type | string | |
|
index
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
índices
|
uploads.indexes | array of object | |
|
identificador
|
uploads.indexes.index.identifier | boolean | |
|
contenido
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
packageId
|
uploads.packageId | string |
binary
Este es el tipo de datos básico "binary".