Compartir a través de

Nitro Sign Enterprise Verified (versión preliminar)

Nitro Sign Enterprise Verified es una conocida 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. NSEV le permite transformar cualquier proceso basado en papel en un flujo digital de un extremo a otro 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.

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 Nitro
URL https://www.gonitro.com/support
Correo Electrónico service@gonitro.com
Metadatos del conector
Publicador Nitro Software Belgium NV
Sitio web https://www.gonitro.com
Directiva de privacidad https://www.gonitro.com/legal/privacy-policy
Categorías Operaciones de TI; Productividad

Nitro Sign Enterprise Verified Connector

Nitro Software, especialista en Smart Document Solutions, ha hecho que Nitro Sign Enterprise Verified Connector for 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. Nitro Sign Enterprise Verified: anteriormente conocido como Nitro Sign Premium y Connected eSignatures.

Prerrequisitos

Para empezar a usar el conector, se requiere una suscripción existente a Nitro Sign Enterprise Verified. Póngase en contacto con su contacto en Nitro Software o vaya a nuestra página de ayuda y soporte técnico en nuestro sitio web para recibir las credenciales.

Documentation

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 nuestra página de ayuda y soporte técnico o buzón de soporte técnico: mailto:service@gonitro.com. La documentación de la API también está disponible en formato Postman.

Hay disponible un glosario para explicar los distintos términos que se usan en esta documentación.

Operaciones admitidas

El conector Nitro Sign Enterprise Verified se basa en la API v4 de Nitro Sign Enterprise Verified. La API 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
Packages Obtener todos los paquetes
Obtener paquete por identificador
Obtener el estado del paquete
Crear un nuevo paquete (estándar o instantáneo)
Eliminar un paquete por identificador
Actualizar el estado de un paquete
Obtener la fecha de expiración de un paquete
Actualizar la fecha de expiración de un paquete
Omitir firmantes
Enviar recordatorios
Descargar un paquete
Descargar la pista de auditoría de un paquete
Documentos Agregar un documento a un paquete
Descargar un documento firmado desde un paquete
Partes interesadas Eliminar una parte interesada por identificador
Obtener todas las partes interesadas de un paquete
Agregar una parte interesada a un paquete
Proceso Obtener todos los pasos de proceso de un paquete
Proceso Agregar un paso en el proceso del paquete
Proceso Sobrescribir los pasos del proceso de un paquete
Proceso Obtener todas las acciones de un paso de proceso
Proceso Eliminar un paso de proceso y todos sus actores
Proceso Agregar un actor a un paso de proceso
Proceso Obtención de todas las acciones en el paso de proceso actual
Other Obtención de todos los idiomas habilitados en la aplicación
Obtener todos los temas que se pueden asignar a un paquete
Obtener todos los grupos de documentos a los que se puede asignar un paquete
Obtención de todos los métodos de firma configurados

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
Host de Nitro Sign cuerda / cadena host y ruta de acceso al entorno de Nitro Sign, por ejemplo, contoso.sign.gonitro.com/esig 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

Actualizar estado del paquete

Actualiza el estado de un paquete.
Actualizar la fecha de expiración de un paquete

Actualizar la fecha de expiración de un paquete
Agregar un actor a un paso de proceso

Agrega un actor a un paso de proceso.
Agregar un documento a un paquete

Agrega un documento a un paquete existente.
Agregar un paso en el proceso del paquete

Agrega un conjunto de acciones al proceso del paquete.
Agregar una parte interesada a un paquete

Agrega una parte interesada al paquete
Crear un nuevo paquete (estándar o instantáneo)

Crea un nuevo paquete. De forma predeterminada, el paquete se crea como borrador. Para crear un paquete instantáneo que esté listo inmediatamente para la firma, establezca la status propiedad Pendingen .

Nota: El POST /packages punto de conexión permite crear paquetes estándar e instantáneos.
Descargar documento del paquete

Descargue un documento firmado de un paquete. Cada documento se descargará como un archivo PDF o XML.
Descargar la pista de auditoría del paquete

Descargue una pista de auditoría firmada sobre la duración de un paquete.
Descargar paquete

Se usa para descargar todos los documentos de un paquete determinado como un archivo Zip.
Devolver todos los métodos de firma configurados actualmente

Devuelve todos los métodos de firma configurados actualmente.
Eliminación de partes interesadas por identificador

Elimina una parte interesada por su identificador.
Eliminar paquete por identificador

Elimina un paquete por su identificador.
Eliminar un paso de proceso y todos sus actores

Elimina un paso de proceso y todos sus actores.
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.
Obtención de todas las acciones en el paso de proceso actual

Obtiene el conjunto actual de acciones que se pueden completar en paralelo.
Obtener el estado del paquete

Recupera el estado actual del paquete.
Obtener la fecha de expiración de un paquete

Recuperar la fecha de expiración de un paquete
Obtener paquete por identificador

Recupera un paquete por su identificador.
Obtener todas las acciones de un paso de proceso

Obtiene un conjunto determinado de acciones que se pueden completar en paralelo desde el proceso.
Obtener todas las partes interesadas de un paquete

Recupera las partes interesadas del paquete.
Obtener todos los paquetes

Obtiene todos los paquetes, estos se ordenan por creationDate.
Obtener todos los pasos del proceso

Obtiene todas las acciones que tendrán que realizarse en el paquete.
Omitir firmantes

Esta llamada omite todos los firmantes que aún no han finalizado y establece su estado en "Omitido", lo que da como resultado que el paquete completo se marque como "Finalizado".
Recuperación de todos los idiomas habilitados en la aplicación

Recupera todos los idiomas que están habilitados en la aplicación.
Recuperar todos los grupos de documentos a los que se pueden asignar paquetes

Recupera todos los grupos de documentos a los que se pueden asignar paquetes.
Recuperar todos los temas que se pueden asignar a un paquete

Recupera todos los temas que se pueden asignar a un paquete. Posible paginar el resultado proporcionando maxQuantity y un continuationToken
Sobrescribir los pasos del proceso de un paquete

Sobrescribe todos los actores de un paquete mediante una matriz 2D donde cada conjunto de actores son acciones que se pueden realizar en paralelo.

Actualizar estado del paquete

Id. de la operación:
Packages_UpdateStatus

Actualiza el estado de un paquete.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
body
 body True string

Actualizar la fecha de expiración de un paquete

Id. de la operación:
Packages_PutExpiryDate

Actualizar la fecha de expiración de un paquete

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
ExpiryTimestamp
 ExpiryTimestamp date-time

Valor de fecha y hora en formato ISO 8601

Agregar un actor a un paso de proceso

Id. de la operación:
Process_StepPost

Agrega un actor a un paso de proceso.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Índice del paso de proceso
 stepIndex True integer

Índice del paso de proceso
Tipo
 Type True string

Tipo de acción que tendrá que realizarse en un paquete
StakeholdersId
 StakeholderId True string

Identificador de una parte interesada en el paquete
SuppressNotifications
 SuppressNotifications boolean

Supresión de notificaciones para el actor
RedirectUrl
 RedirectUrl url

Dirección URL de redireccionamiento una vez completada la acción del actor
Id
 Id string

Identificador de un elemento existente. Si se usa, todos los demás campos deben estar vacíos.
Tipo
 Type string

Tipo de elemento
ExternalReference
 ExternalReference string

Referencia externa del paquete
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento
DocumentId
 DocumentId string

Identificador del documento en el paquete
SigningMethods
 SigningMethods array of string
Nombre
 Name string

Nombre del aviso legal que se va a agregar al campo de firma.
Content
 Content string

Contenido de aviso legal personalizado.
Language
 Language string

Código ISO de 2 letras de un país (ISO 639-1)

Devoluciones

Body
Response.Actor

Agregar un documento a un paquete

Id. de la operación:
Documents_AddToPackage

Agrega un documento a un paquete existente.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Nombre
 Name True string

Nombre del documento
IsOptional
 IsOptional boolean

Indica si el documento debe ser opcional para la firma.
Language
 Language True string

Código ISO de 2 letras de un país (ISO 639-1)
ExternalReference
 ExternalReference string

Referencia externa del paquete
ProofCorrelationId
 ProofCorrelationId string

Un identificador único global
TargetType (Tipo de destino)
 TargetType string

Solo funcionará cuando el servidor esté configurado para conversiones de documentos.
TargetFormat
 TargetFormat string

El formato de destino define si es necesario realizar una conversión adicional.
PdfErrorHandling
 PdfErrorHandling string

Cómo tratar con archivos PDF que contienen errores menores
ContentType
 ContentType True string

Tipo MIME del documento
Base64Data
 Base64Data True byte

Contenido del documento codificado en Base64
Tipo
 Type True string

Tipo de elemento
ExternalReference
 ExternalReference string

Referencia externa del paquete
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento
SigningMethods
 SigningMethods array of string
Nombre
 Name string

Nombre del aviso legal que se va a agregar al campo de firma.
Content
 Content string

Contenido de aviso legal personalizado.
Language
 Language string

Código ISO de 2 letras de un país (ISO 639-1)

Devoluciones

Body
Response.Document

Agregar un paso en el proceso del paquete

Id. de la operación:
Process_PostStep

Agrega un conjunto de acciones al proceso del paquete.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Tipo
 Type True string

Tipo de acción que tendrá que realizarse en un paquete
StakeholdersId
 StakeholderId True string

Identificador de una parte interesada en el paquete
SuppressNotifications
 SuppressNotifications boolean

Supresión de notificaciones para el actor
RedirectUrl
 RedirectUrl url

Dirección URL de redireccionamiento una vez completada la acción del actor
Id
 Id string

Identificador de un elemento existente. Si se usa, todos los demás campos deben estar vacíos.
Tipo
 Type string

Tipo de elemento
ExternalReference
 ExternalReference string

Referencia externa del paquete
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento
DocumentId
 DocumentId string

Identificador del documento en el paquete
SigningMethods
 SigningMethods array of string
Nombre
 Name string

Nombre del aviso legal que se va a agregar al campo de firma.
Content
 Content string

Contenido de aviso legal personalizado.
Language
 Language string

Código ISO de 2 letras de un país (ISO 639-1)

Devoluciones

Un conjunto de actores en un paso de proceso.

response
array of Response.Actor

Agregar una parte interesada a un paquete

Id. de la operación:
Packages_AddStakeholder

Agrega una parte interesada al paquete

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Tipo
 Type True string

El tipo de parte interesada
ExternalReference
 ExternalReference string

Referencia externa del paquete
Language
 Language True string

Código ISO de 2 letras de un país (ISO 639-1)
Primer Nombre
 FirstName string

Nombre de la parte interesada
Apellido
 LastName True string

Apellidos de la parte interesada
Dirección de correo electrónico
 EmailAddress True email

Una dirección de correo electrónico
BirthDate
 BirthDate date
Número de teléfono
 PhoneNumber string

Un número de teléfono
AdditionalProperties
 AdditionalProperties object

Propiedades adicionales configurables de la parte interesada
Tipo
 Type True string

Tipo de acción que tendrá que realizarse en un paquete
SuppressNotifications
 SuppressNotifications boolean

Supresión de notificaciones para el actor
RedirectUrl
 RedirectUrl url

Dirección URL de redireccionamiento una vez completada la acción del actor
RedirectType
 RedirectType string
BackButtonUrl
 BackButtonUrl url

Dirección URL a la que se envía el usuario después de cerrar la sesión
Id
 Id string

Identificador de un elemento existente. Si se usa, todos los demás campos deben estar vacíos.
Tipo
 Type string

Tipo de elemento
ExternalReference
 ExternalReference string

Referencia externa del paquete
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento
DocumentId
 DocumentId string

Identificador del documento en el paquete
SigningMethods
 SigningMethods array of string
Nombre
 Name string

Nombre del aviso legal que se va a agregar al campo de firma.
Content
 Content string

Contenido de aviso legal personalizado.
Language
 Language string

Código ISO de 2 letras de un país (ISO 639-1)

Devoluciones

Body
Response.Stakeholder

Crear un nuevo paquete (estándar o instantáneo)

Id. de la operación:
Packages_CreatePackage

Crea un nuevo paquete. De forma predeterminada, el paquete se crea como borrador. Para crear un paquete instantáneo que esté listo inmediatamente para la firma, establezca la status propiedad Pendingen .

Nota: El POST /packages punto de conexión permite crear paquetes estándar e instantáneos.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre
 Name True string

Nombre del paquete
Initiator
 Initiator True email

Una dirección de correo electrónico
ExternalReference
 ExternalReference string

Referencia externa del paquete
Estado
 Status string

Estado del paquete creado.

  • Use "Draft" para crear un paquete estándar que se pueda modificar antes de enviarlo.
  • Use "Pending" para crear un paquete instantáneo que esté listo inmediatamente para la firma.
DocumentGroupCode
 DocumentGroupCode string

Código de grupo de documentos para el paquete
ExpiryDate
 ExpiryDate date-time

Valor de fecha y hora en formato ISO 8601
Nombre
 Name True string

Nombre del documento
IsOptional
 IsOptional boolean

Indica si el documento debe ser opcional para la firma.
Language
 Language True string

Código ISO de 2 letras de un país (ISO 639-1)
ExternalReference
 ExternalReference string

Referencia externa del paquete
ProofCorrelationId
 ProofCorrelationId string

Un identificador único global
TargetType (Tipo de destino)
 TargetType string

Solo funcionará cuando el servidor esté configurado para conversiones de documentos.
TargetFormat
 TargetFormat string

El formato de destino define si es necesario realizar una conversión adicional.
PdfErrorHandling
 PdfErrorHandling string

Cómo tratar con archivos PDF que contienen errores menores
ContentType
 ContentType True string

Tipo MIME del documento
Base64Data
 Base64Data True byte

Contenido del documento codificado en Base64
Tipo
 Type True string

Tipo de elemento
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento
SigningMethods
 SigningMethods array of string
Nombre
 Name string

Nombre del aviso legal que se va a agregar al campo de firma.
Content
 Content string

Contenido de aviso legal personalizado.
Tipo
 Type True string

El tipo de parte interesada
ExternalReference
 ExternalReference string

Referencia externa del paquete
Language
 Language True string

Código ISO de 2 letras de un país (ISO 639-1)
Primer Nombre
 FirstName string

Nombre de la parte interesada
Apellido
 LastName True string

Apellidos de la parte interesada
Dirección de correo electrónico
 EmailAddress True email

Una dirección de correo electrónico
BirthDate
 BirthDate date
Número de teléfono
 PhoneNumber string

Un número de teléfono
AdditionalProperties
 AdditionalProperties object

Propiedades adicionales configurables de la parte interesada
Tipo
 Type True string

Tipo de acción que tendrá que realizarse en un paquete
SuppressNotifications
 SuppressNotifications boolean

Supresión de notificaciones para el actor
RedirectUrl
 RedirectUrl url

Dirección URL de redireccionamiento una vez completada la acción del actor
RedirectType
 RedirectType string
BackButtonUrl
 BackButtonUrl url

Dirección URL a la que se envía el usuario después de cerrar la sesión
ProcessStep
 ProcessStep integer

Número de paso de proceso
DocumentIndex
 DocumentIndex True integer

Índice del documento en el paquete (a partir de 0): solo está disponible en el punto de conexión Crear paquete.
Tipo
 Type True string

Tipo de elemento
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento
SigningMethods
 SigningMethods True array of string
Nombre
 Name string

Nombre del aviso legal que se va a agregar al campo de firma.
Content
 Content string

Contenido de aviso legal personalizado.
ThemeCode
 ThemeCode string

Identificador del tema del paquete
CallBackUrl
 CallBackUrl url

Dirección URL de devolución de llamada después de realizar acciones
NotificationCallBackUrl
 NotificationCallBackUrl url

Dirección URL de devolución de llamada cuando un firmante solicita una nueva dirección URL de firma
DefaultRedirectUrl
 DefaultRedirectUrl url

Url de redireccionamiento después de la finalización de la acción
F2fRedirectUrl
 F2fRedirectUrl url

Dirección URL de redireccionamiento después de la firma cara a cara
IsUnsignedContentDownloadable
 IsUnsignedContentDownloadable boolean

Si se puede descargar contenido sin firmar
IsReassignEnabled
 IsReassignEnabled boolean

Indica si la reasignación está habilitada

Devoluciones

Body
Response.Package.Get

Descargar documento del paquete

Id. de la operación:
Documents_DownloadDocumentFromPackage

Descargue un documento firmado de un paquete. Cada documento se descargará como un archivo PDF o XML.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Identificador único del documento contenido en el paquete
 documentId True string

Identificador único del documento contenido en el paquete

Devoluciones

response
binary

Descargar la pista de auditoría del paquete

Id. de la operación:
Packages_DownloadAuditTrail

Descargue una pista de auditoría firmada sobre la duración de un paquete.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Un código ISO de idioma 2 letras (ISO 639-1)
 culture True string

Un código ISO de idioma 2 letras (ISO 639-1)

Devoluciones

response
binary

Descargar paquete

Id. de la operación:
Packages_DownloadPackage

Se usa para descargar todos los documentos de un paquete determinado como un archivo Zip.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Devoluciones

response
binary

Devolver todos los métodos de firma configurados actualmente

Id. de la operación:
GetAllSigningMethods

Devuelve todos los métodos de firma configurados actualmente.

Parámetros

Nombre Clave Requerido Tipo Description
devolver solo métodos de firma activos o inactivos
 isActive boolean

devolver solo métodos de firma activos o inactivos

Devoluciones

response
array of ConfiguredSigningMethod

Eliminación de partes interesadas por identificador

Id. de la operación:
Stakeholder_DeleteById

Elimina una parte interesada por su identificador.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Identificador único de la parte interesada
 stakeholderId True string

Identificador único de la parte interesada

Eliminar paquete por identificador

Id. de la operación:
Packages_DeleteById

Elimina un paquete por su identificador.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Eliminar un paso de proceso y todos sus actores

Id. de la operación:
Process_DeleteStep

Elimina un paso de proceso y todos sus actores.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Índice del paso de proceso
 stepIndex True integer

Índice del paso de proceso

Enviar recordatorios de paquete

Id. de la operación:
Packages_SendReminders

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

Obtención de todas las acciones en el paso de proceso actual

Id. de la operación:
Process_GetCurrentStep

Obtiene el conjunto actual de acciones que se pueden completar en paralelo.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Devoluciones

Nombre Ruta de acceso Tipo Description
Productos
 Items array of Response.Actor

Obtener el estado del paquete

Id. de la operación:
Packages_GetStatus

Recupera el estado actual del paquete.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Devoluciones

Body
Response.Package.Status

Obtener la fecha de expiración de un paquete

Id. de la operación:
Packages_GetExpiryDate

Recuperar la fecha de expiración de un paquete

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Devoluciones

Valor de fecha y hora en formato ISO 8601

response
Common.DateTime

Obtener paquete por identificador

Id. de la operación:
Packages_GetPackage

Recupera un paquete por su identificador.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Devoluciones

Body
Response.Package.Get

Obtener todas las acciones de un paso de proceso

Id. de la operación:
Process_GetStep

Obtiene un conjunto determinado de acciones que se pueden completar en paralelo desde el proceso.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Índice del paso de proceso
 stepIndex True integer

Índice del paso de proceso

Devoluciones

Nombre Ruta de acceso Tipo Description
Productos
 Items array of Response.Actor

Obtener todas las partes interesadas de un paquete

Id. de la operación:
Packages_GetStakeholders

Recupera las partes interesadas del paquete.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Devoluciones

response
array of Response.Stakeholder

Obtener todos los paquetes

Id. de la operación:
Packages_Get

Obtiene todos los paquetes, estos se ordenan por creationDate.

Parámetros

Nombre Clave Requerido Tipo Description
Número de página que se va a recuperar
 pageNumber integer

Número de página que se va a recuperar
Número de elementos por página
 pageSize integer

Número de elementos por página
Devolver paquetes creados antes de esta fecha
 createdBefore date-time

Devolver paquetes creados antes de esta fecha
Devolver paquetes creados después de esta fecha
 createdAfter date-time

Devolver paquetes creados después de esta fecha
Estado de los paquetes que se van a filtrar
 status string

Estado de los paquetes que se van a filtrar
Código de grupo de documentos para filtrar paquetes
 documentGroupCode string

Código de grupo de documentos para filtrar paquetes
Correo electrónico del iniciador del paquete que se va a filtrar
 initiator email

Correo electrónico del iniciador del paquete que se va a filtrar
Nombre del paquete que se va a filtrar
 packageName string

Nombre del paquete que se va a filtrar
Referencia externa para filtrar paquetes
 externalReference string

Referencia externa para filtrar paquetes
Especificar cómo se ordena el resultado, el valor predeterminado es descendente.
 sort string

Especificar cómo se ordena el resultado, el valor predeterminado es descendente.

Devoluciones

Nombre Ruta de acceso Tipo Description
PageNumber
 PageNumber integer

Número de página actual
PageSize
 PageSize integer

Número de elementos por página
TotalPages
 TotalPages integer

Número total de páginas
TotalItems
 TotalItems integer

Número total de elementos
Productos
 Items array of Response.Package.Get

Obtener todos los pasos del proceso

Id. de la operación:
Process_Get

Obtiene todas las acciones que tendrán que realizarse en el paquete.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete

Devoluciones

Nombre Ruta de acceso Tipo Description
array of array
items
 array of Response.Actor

Un conjunto de actores en un paso de proceso.

Omitir firmantes

Id. de la operación:
Packages_SkipSigners

Esta llamada omite todos los firmantes que aún no han finalizado 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

Recuperación de todos los idiomas habilitados en la aplicación

Id. de la operación:
GetAllEnabledLanguages

Recupera todos los idiomas que están habilitados en la aplicación.

Devoluciones

Nombre Ruta de acceso Tipo Description
EnabledLanguages
 EnabledLanguages array of object

Lista de idiomas habilitados
DisplayName (Nombre para mostrar)
 EnabledLanguages.DisplayName string

Nombre para mostrar del idioma
NativeName
 EnabledLanguages.NativeName string

Nombre nativo del idioma
IsoCultureCode
 EnabledLanguages.IsoCultureCode string

El código ISO de 2 letras (ISO 639-1) del idioma

Recuperar todos los grupos de documentos a los que se pueden asignar paquetes

Id. de la operación:
GetDocumentGroups

Recupera todos los grupos de documentos a los que se pueden asignar paquetes.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre del grupo de documentos (o parte) que se va a buscar
 name string

Nombre del grupo de documentos (o parte) que se va a buscar

Devoluciones

Nombre Ruta de acceso Tipo Description
DocumentGroups
 DocumentGroups array of object

Lista de grupos de documentos
Código
 DocumentGroups.Code string

Código del grupo de documentos
Nombre
 DocumentGroups.Name string

Nombre del grupo de documentos

Recuperar todos los temas que se pueden asignar a un paquete

Id. de la operación:
GetAllThemes

Recupera todos los temas que se pueden asignar a un paquete. Posible paginar el resultado proporcionando maxQuantity y un continuationToken

Parámetros

Nombre Clave Requerido Tipo Description
Token para obtener el siguiente conjunto de resultados
 continuationToken string

Token para obtener el siguiente conjunto de resultados
Cantidad máxima de resultados que se van a devolver
 maxQuantity integer

Cantidad máxima de resultados que se van a devolver
Orden en el que se ordenan los resultados
 sortOrder string

Orden en el que se ordenan los resultados
especificar en qué campo se va a ordenar
 sortField string

especificar en qué campo se va a ordenar

Devoluciones

Nombre Ruta de acceso Tipo Description
Token de Continuación
 ContinuationToken string

Token para recuperar la página siguiente de resultados
Productos
 Items array of object

Lista que contiene los temas
Código
 Items.Code string

Código del tema
Nombre
 Items.Name string

Nombre del tema
MaxQuantity
 MaxQuantity integer

Número máximo de resultados que se devolverán por solicitud
Total
 Total integer

Número total de resultados.

Sobrescribir los pasos del proceso de un paquete

Id. de la operación:
Process_Put

Sobrescribe todos los actores de un paquete mediante una matriz 2D donde cada conjunto de actores son acciones que se pueden realizar en paralelo.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador único del paquete
 packageId True string

Identificador único del paquete
Tipo
 Type True string

Tipo de acción que tendrá que realizarse en un paquete
StakeholdersId
 StakeholderId True string

Identificador de una parte interesada en el paquete
SuppressNotifications
 SuppressNotifications boolean

Supresión de notificaciones para el actor
RedirectUrl
 RedirectUrl url

Dirección URL de redireccionamiento una vez completada la acción del actor
Id
 Id string

Identificador de un elemento existente. Si se usa, todos los demás campos deben estar vacíos.
Tipo
 Type string

Tipo de elemento
ExternalReference
 ExternalReference string

Referencia externa del paquete
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento
DocumentId
 DocumentId string

Identificador del documento en el paquete
SigningMethods
 SigningMethods array of string
Nombre
 Name string

Nombre del aviso legal que se va a agregar al campo de firma.
Content
 Content string

Contenido de aviso legal personalizado.
Language
 Language string

Código ISO de 2 letras de un país (ISO 639-1)

Definiciones

ConfiguredSigningMethod

Un método de firma configurado en eSignatures

Nombre Ruta de acceso Tipo Description
IsActive
 IsActive boolean

Si se puede usar signingMethod para crear nuevos campos de firma
Nombre
 Name string

Nombre configurado del método de firma
DisplayNames
 DisplayNames object

Nombre por idioma que se mostrará a un firmante.
DisplayNamesInitiator
 DisplayNamesInitiator object

Nombre por idioma que se debe mostrar al iniciador al crear el paquete.
Descripciones
 Descriptions object

Descripción del método de firma por lenguaje para proporcionar más información sobre el método de firma durante la creación del paquete.
RequiredProperties
 RequiredProperties array of string

Las propiedades necesarias para la firma obligatoria
KeyPairs
 KeyPairs array of KeyPair

KeyPairs disponibles que se pueden usar para firmar con este método

KeyPair

representación de un par de claves de firma

Nombre Ruta de acceso Tipo Description
Nombre
 Name string

Nombre del par de claves
DisplayNames
 DisplayNames object

Nombre por idioma que se mostrará a un iniciador

Common.Guid

Un identificador único global

Un identificador único global

string

Common.EmailAddress

Una dirección de correo electrónico

Una dirección de correo electrónico

email

Common.Language

Código ISO de 2 letras de un país (ISO 639-1)

Código ISO de 2 letras de un país (ISO 639-1)

string

Common.PhoneNumber

Un número de teléfono

Un número de teléfono

string

Common.ExternalReference

Referencia externa del paquete

Referencia externa del paquete

string

Common.AdditionalProperties

Propiedades adicionales configurables de la parte interesada

Nombre Ruta de acceso Tipo Description
object

Propiedades adicionales configurables de la parte interesada

Common.DateTime

Valor de fecha y hora en formato ISO 8601

Valor de fecha y hora en formato ISO 8601

date-time

Package.Status

Estado del paquete

Estado del paquete

string

Package.Name

Nombre del paquete

Nombre del paquete

string

Document.Name

Nombre del documento

Nombre del documento

string

Document.Status

Estado de un documento

Estado de un documento

string

Document.DocumentOptions

Define parámetros de documento opcionales

Nombre Ruta de acceso Tipo Description
TargetType (Tipo de destino)
 TargetType string

Solo funcionará cuando el servidor esté configurado para conversiones de documentos.
TargetFormat
 PdfOptions.TargetFormat string

El formato de destino define si es necesario realizar una conversión adicional.
PdfErrorHandling
 PdfOptions.PdfErrorHandling string

Cómo tratar con archivos PDF que contienen errores menores

Stakeholders.FirstName

Nombre de la parte interesada

Nombre de la parte interesada

string

Stakeholders.LastName

Apellidos de la parte interesada

Apellidos de la parte interesada

string

Actor.Type

Tipo de acción que tendrá que realizarse en un paquete

Tipo de acción que tendrá que realizarse en un paquete

string

Actor.Status

Estado de un actor

Estado de un actor

string

Element.Type

Tipo de elemento

Tipo de elemento

string

Element.Status

Estado de un elemento

Estado de un elemento

string

Element.Location

Nombre Ruta de acceso Tipo Description
Página
 Page integer

Número de página del documento
Arriba
 Top number

Posición superior en píxeles
Left
 Left number

Posición izquierda en píxeles

Element.Dimensions

Nombre Ruta de acceso Tipo Description
Ancho
 Width number

Ancho del elemento
Altura
 Height number

Alto del elemento

Response.Package.Get

Nombre Ruta de acceso Tipo Description
Id
 Id Common.Guid

Un identificador único global
Nombre
 Name Package.Name

Nombre del paquete
Initiator
 Initiator Common.EmailAddress

Una dirección de correo electrónico
ExternalReference
 ExternalReference Common.ExternalReference

Referencia externa del paquete
CreationDate
 CreationDate Common.DateTime

Valor de fecha y hora en formato ISO 8601
Estado
 Status Package.Status

Estado del paquete
ExpiryDate
 ExpiryDate Common.DateTime

Valor de fecha y hora en formato ISO 8601
Documentos
 Documents array of Response.Document
Partes interesadas
 Stakeholders array of Response.Stakeholder

Response.Document

Nombre Ruta de acceso Tipo Description
Id
 Id Common.Guid

Un identificador único global
Estado
 Status Document.Status

Estado de un documento
DocumentOptions
 DocumentOptions Document.DocumentOptions

Define parámetros de documento opcionales
Nombre
 Name Document.Name

Nombre del documento
Language
 Language Common.Language

Código ISO de 2 letras de un país (ISO 639-1)
ExternalReference
 ExternalReference Common.ExternalReference

Referencia externa del paquete
ProofCorrelationId
 ProofCorrelationId Common.Guid

Un identificador único global

Response.Stakeholders

Nombre Ruta de acceso Tipo Description
Tipo
 Type string

El tipo de parte interesada
ExternalReference
 ExternalReference Common.ExternalReference

Referencia externa del paquete
Id
 Id Common.Guid

Un identificador único global
Language
 Language Common.Language

Código ISO de 2 letras de un país (ISO 639-1)
Primer Nombre
 FirstName Stakeholder.FirstName

Nombre de la parte interesada
Apellido
 LastName Stakeholder.LastName

Apellidos de la parte interesada
Dirección de correo electrónico
 EmailAddress Common.EmailAddress

Una dirección de correo electrónico
BirthDate
 BirthDate date
Número de teléfono
 PhoneNumber Common.PhoneNumber

Un número de teléfono
AdditionalProperties
 AdditionalProperties Common.AdditionalProperties

Propiedades adicionales configurables de la parte interesada
Actors
 Actors array of Response.Actor

Response.Actor

Nombre Ruta de acceso Tipo Description
Tipo
 Type Actor.Type

Tipo de acción que tendrá que realizarse en un paquete
Id
 Id Common.Guid

Un identificador único global
StakeholdersId
 StakeholderId Common.Guid

Un identificador único global
Estado
 Status Actor.Status

Estado de un actor
SuppressNotifications
 SuppressNotifications boolean

Supresión de notificaciones para el actor
RedirectUrl
 RedirectUrl url

Dirección URL de redireccionamiento una vez completada la acción del actor
Elements
 Elements array of Response.Element

Response.Element

Nombre Ruta de acceso Tipo Description
Tipo
 Type Element.Type

Tipo de elemento
Id
 Id Common.Guid

Un identificador único global
ActorId
 ActorId Common.Guid

Un identificador único global
DocumentId
 DocumentId integer

Identificador del documento en el paquete
Estado
 Status Element.Status

Estado de un elemento
ExternalReference
 ExternalReference Common.ExternalReference

Referencia externa del paquete
Ubicación
 Location Element.Location
Dimensiones
 Dimensions Element.Dimensions
SigningMethods
 SigningMethods array of string
UsedSigningMethod
 UsedSigningMethod string

Método de firma usado

Response.Package.Status

Nombre Ruta de acceso Tipo Description
Estado
 Status Package.Status

Estado del paquete

binary

Este es el tipo de datos básico "binary".