Nitro Sign (versión preliminar)

Nitro Sign API permite flujos de trabajo seguros y integrales de eSignature al permitir que las aplicaciones creen, administren y realicen un seguimiento de los procesos de firma digital. Proporciona funcionalidades para crear sobres, cargar documentos, agregar participantes, definir el orden de firma y enviar documentos para la firma a través de un enfoque totalmente automatizado basado en API.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones 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 - Azure regiones de China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones 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 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
Email	prosupport@sfdc.gonitro.com

Metadatos del conector
Publicador	Nitro PDF
Sitio web	https://www.gonitro.com/
Directiva de privacidad	https://www.gonitro.com/legal/privacy-policy
Categorías	Productividad; Operaciones de TI

Nitro Sign Connector

Visión general

El conector Nitro Sign permite flujos de trabajo seguros eSignature de un extremo a otro directamente desde Power Automate y Power Apps. Permite a las aplicaciones crear y administrar sobres de firma, cargar y reordenar documentos, agregar participantes y definir el orden de firma, colocar la firma y los campos de datos, enviar documentos para firma, realizar un seguimiento del progreso y descargar los archivos originales, sellados y de seguimiento de auditoría, todo ello a través de un enfoque totalmente automatizado y controlado por API.

Publisher: Nitro Software

Prerequisites

Para usar Nitro Sign a través de este conector, necesitará:

Una cuenta nitro con Nitro Sign habilitado
https://developers.gonitro.com/
Un plan de Microsoft PowerApps o Power Automate con funcionalidades del conector personalizado.

Autenticación

Nitro Sign usa OAuth 2.0 de máquina a máquina con la concesión de credenciales de cliente para generar tokens de acceso para las solicitudes de API.

Cómo funciona

Cree una aplicación de API en el portal de autoservicio de Nitro y obtenga el identificador de cliente asociado y el secreto de cliente.
El conector se autentica intercambiando estas credenciales para un token de acceso de portador.
A continuación, el token se usa para autorizar las llamadas posteriores de Nitro Sign API.

Cree credenciales y lea la guía detallada:
https://developers.gonitro.com/docs/authentication/credentials

Creación de una conexión en Power Automate/Power Apps

Al agregar el conector a un flujo o aplicación:

Haga clic en Agregar una nueva conexión.
Escriba el identificador de cliente y el secreto de cliente (emitidos en el portal para desarrolladores de Nitro).
Seleccione la región nitro (Europa, Estados Unidos o APAC), la región asociada a su cuenta nitro.
Guarde la conexión: en primer uso, el conector intercambia el identificador de cliente y el secreto de cliente para un token de acceso de corta duración mediante la concesión de credenciales de cliente de OAuth 2.0, la almacena en caché y la renueva automáticamente. Las credenciales solo se usan para obtener el token; Las llamadas API posteriores se autentican con un token de portador en su nombre.

Nota: No se requiere ningún inicio de sesión interactivo por el usuario; este flujo está diseñado para escenarios de servidor a servidor o de aplicación a aplicación.

Operaciones admitidas

El conector agrupa sus acciones en torno a los cuatro recursos de un flujo de trabajo de firma ( sobres, documentos, campos y participantes ), además de un conjunto de acciones de descarga para recuperar archivos terminados.

1. Sobres

Un sobre es el contenedor de los documentos, participantes y campos en una única solicitud de firma.

Sobres de lista
Devuelve todos los sobres asociados a la aplicación de la cuenta. Los resultados se paginan: la respuesta incluye un token de cursor de página siguiente , que puede proporcionar al parámetro Opcional Page After para recuperar la página siguiente (o Page Before to page backwards). Ambos parámetros de cursor están en Avanzado y solo son necesarios al recorrer grandes conjuntos de resultados.
Crear sobre
Crea un nuevo sobre con un nombre, un mensaje de notificación (asunto + cuerpo, con variables dinámicas como $(sender_name_or_email) y $(envelope_name)) y el modo de firma:
- parallel — todos los participantes reciben una notificación al mismo tiempo y pueden firmar de forma independiente.
- sequential — los participantes reciben una notificación cada vez, en el orden en que se agregaron.
Obtener sobre por identificador
Recupera los detalles de un sobre específico por su UUID.
Actualizar sobre
Actualiza el nombre del sobre, la configuración de notificación o el modo de firma. Todos los campos son opcionales.
Eliminar sobre por identificador
Elimina permanentemente un sobre y todos los documentos, campos y participantes asociados. Esto no se puede deshacer.
Envío de sobre para la firma
Envía el sobre a los participantes para la recopilación de firmas. Antes de enviar, el sobre normalmente debe tener sus documentos, participantes y campos de firma agregados (a través de Create Document by Envelope ID, Create Participant(s) by Envelope ID y Create Field(s) by Document ID). Todos los documentos del sobre deben tener un estado cargado antes de que se pueda enviar el sobre.
Enviar recordatorios para sobre
Desencadena notificaciones de recordatorio a los participantes pendientes. Si no se proporciona ninguna configuración de notificación, se usa la plantilla de notificación predeterminada configurada para el sobre.
Cancelar sobre por identificador
Cancela la solicitud de firma. Solo se pueden cancelar los sobres que ya se han enviado para la firma.

2. Documentos

Los documentos son los archivos adjuntos a un sobre y firmados por los participantes.

Enumerar documentos por identificador de sobre
Recupera todos los documentos asociados a un sobre.
Crear documento por identificador de sobre
Carga un documento en un sobre existente. Proporcione el archivo más campos simples y tipados, sin JSON escrito a mano:
- Archivo de documento : el archivo que se va a cargar.
- Nombre del documento : el nombre en el que se va a almacenar el documento.
- Tipo de contenido(avanzado, opcional): el tipo MIME del archivo; el valor predeterminado es application/pdf. Cuando se omite, solo se aceptan archivos PDF.
Obtener documento por identificador
Recupera los detalles de un documento específico en un sobre.
Actualizar documento por identificador
Actualiza los metadatos del documento. Actualmente, solo se puede cambiar el nombre del documento.
Eliminar documento por identificador
Elimina permanentemente un documento de un sobre.
Reordenar documentos por identificador de sobre
Reordena los documentos en un sobre basándose en una lista proporcionada de identificadores de documento.

3. Campos

Los campos son los elementos interactivos (firma, iniciales, fecha, etc.) colocados en un documento y asignados a un participante.

Enumerar campos por identificador de documento
Recupera todos los campos asociados a un documento específico.
Crear campos por identificador de documento
Crea uno o varios campos en un documento y los asigna a los participantes. Proporcione un elemento para un único campo o varios elementos para una solicitud masiva. Cada campo especifica:
- participantID : el participante asignado al campo.
- type— uno de signature, initials, name, datetitle, company, , checkbox, . custom
- page : número de página (indexación basada en 1).
- Posición X, Posición Y, Ancho, Alto : posición y tamaño del campo, cada uno especificado como un número independiente en puntos (X/Y se mide desde el borde izquierdo o superior de la página). Reemplazan a la matriz única boundingBox anterior, por lo que cada valor es un campo con tipo en la interfaz de usuario en lugar de una lista integrada a mano.
- Opcional: required (valor predeterminado true) y , en Avanzado ( format por ejemplo, MM/DD/YYYY para campos de fecha) y modifiable.
Actualizar campo por identificador
Actualiza las propiedades de un campo existente. El campo type debe proporcionarse y debe coincidir con el tipo de campo existente; se usa para identificar el esquema de campo y no cambia el tipo de campo.
Eliminar campo por identificador
Elimina permanentemente un campo de un documento.

4. Participantes

Los participantes son las personas que reciben el sobre, ya sea para firmarlo o mantenerse informados.

Enumerar participantes por identificador de sobre
Recupera todos los participantes asociados a un sobre.
Crear participantes por identificador de sobre
Agrega uno o varios participantes a un sobre. Proporcione un elemento para un solo participante o varios elementos para una solicitud masiva. Cada participante especifica:
- email : dirección de correo electrónico del participante.
- role — signer (puede tener campos asignados para la firma) o cc (acceso de solo lectura).
- authentication (avanzado, opcional) — actualmente Código de acceso: un código de acceso estático que el participante debe proporcionar antes de firmar. Abra esta sección solo si el participante debe autenticarse antes de firmar.
Actualizar participante por identificador
Actualiza la configuración de autenticación de un participante. No se puede cambiar el correo electrónico del participante.
Eliminar participante por identificador
Elimina permanentemente un participante de un sobre.

5. Descargas

Recupere los archivos terminados una vez que los documentos se hayan firmado y sellado.

Descargar sobre original
Descarga los documentos originales sin firmar de un sobre como archivo ZIP .
Descargar sobre sellado
Descarga los documentos firmados sellados, junto con el registro de auditoría, como un archivo ZIP .
Descargar documento sellado por identificador
Descarga un único documento firmado sellado como un archivo PDF .
Descargar registro de auditoría de sobre
Descarga la pista de auditoría completa de un sobre como un archivo PDF .

Las acciones de descarga exponen el nombre de archivo nativo del selector y los tokens de contenido de archivo (más tipo de contenido de archivo). Coloque el contenido del archivo directamente en la entrada del archivo de un paso de bajada (por ejemplo, OneDrive /SharePoint Crear archivo) y Nombre de archivo en su entrada de nombre de archivo. No se requiere ninguna body('Action_Name') expresión o nombre de archivo escrito manualmente; el conector ajusta el archivo ZIP o PDF descargado en un sobre JSON para que Power Automate los muestre como tokens de contenido dinámico normal.

Flujo de trabajo de firma típico

Un flujo de firma completo encadena las acciones anteriores en orden. Un flujo de Power Automate común tiene este aspecto:

Crear sobre : establezca el nombre, el asunto o el cuerpo de la notificación y el modo de firma (parallel o sequential). Guarde el identificador de sobre devuelto.
Crear documento por identificador de sobre : cargue uno o varios archivos en el sobre (mediante el identificador de sobre del paso 1). Guarde cada identificador de documento devuelto.
(Opcional)Reordenar documentos por identificador de sobre: establezca el orden del documento.
Crear participantes por identificador de sobre : agregue los firmantes y destinatarios CC, con su autenticación de código de acceso. Guarde cada identificador de participante devuelto.
Crear campos por id. de documento : coloque los campos firma/fecha/etc. de cada documento y asígnelos a los participantes (mediante el id. de documento del paso 2 y el id. de participante del paso 3).
Enviar sobre para firma : envíe el sobre. Todos los documentos deben estar en el estado cargado primero.
(Mientras está pendiente)Enviar recordatorios para sobre a los participantes de nudge, o Cancelar sobre por identificador para detener la solicitud.
(Cuando haya finalizado)Descargar sobre / sellado Descargar documento sellado por id. / Descargue el rastro de auditoría del sobre para recuperar los archivos terminados.

Sugerencia: El identificador de sobre, el identificador de documento y el identificador de participante devueltos por las acciones de creación fluyen naturalmente en las acciones posteriores a través del selector de contenido dinámico de Power Automate, elija el token de identificador de la acción ascendente en lugar de escribirlo.

Errores y limitación

Nitro Sign API puede devolver los siguientes errores:

400 : solicitud incorrecta
401 — No autorizado
404 — No encontrado
409 — Conflicto (por ejemplo, actuar sobre un sobre en un estado que no permite la operación)
413 : contenido demasiado grande
415: tipo de medio no admitido
422: entidad inprocesable
500: error interno del servidor

Limitación de velocidad

Llamadas API por conexión: 100 por 60 segundos.

Límites de la plataforma

File Size.

Máximo: 25 MB por solicitud
Se aplica a las operaciones de un solo archivo y de varios archivos.

Recuento de páginas

Máximo: 250 páginas por documento individual
El total de páginas combinadas en varios documentos puede superar los 250.

Tiempo de retención

Los archivos de entrada y salida se eliminan aproximadamente 15 minutos después de la finalización de la operación.

Notas

Las acciones de sobre, documento, campo y administración de participantes devuelven JSON.
Las acciones de descarga devuelven el archivo (ZIP o PDF) encapsulado en un sobre JSON que expone el nombre de archivo, el tipo de contenido del archivo y el contenido de archivo como tokens nativos del selector, por lo que los resultados se pueden encadenar en una acción de archivo de bajada sin expresiones.
El modo de firma (parallel frente sequentiala ) se establece cuando se crea el sobre y se puede cambiar con El sobre de actualización antes de enviar el sobre.
Actualmente, la autenticación de participantes solo admite código de acceso .

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	Required
Id. de cliente nitro	securestring	Identificador de cliente de la aplicación Nitro	True
Secreto de cliente nitro	securestring	Secreto de cliente de la aplicación Nitro	True
Región nitro	string	Seleccione la región de Nitro API para su cuenta.	True

Acciones

Actualizar campo por identificador	Actualiza las propiedades de un campo existente en un documento de signo nitro. El tipo de campo debe proporcionarse y debe coincidir con el tipo de campo existente; la API la usa para identificar el esquema de campo y no cambia el tipo de campo.
Actualizar documento por identificador	Actualiza los metadatos de un documento existente dentro de un sobre Nitro Sign. Actualmente, solo se puede actualizar el nombre del documento.
Actualizar participante por identificador	Actualiza la configuración de autenticación de un participante en un sobre Nitro Sign. No se puede actualizar el correo electrónico del participante.
Actualizar sobre	Actualiza un sobre nitro sign existente. Puede modificar el nombre del sobre, la configuración de notificación, el modo de firma o cualquier combinación de estos campos.
Cancelar sobre por identificador	Cancela la solicitud de firma de un sobre Nitro Sign. Solo se pueden cancelar los sobres que se han enviado para firmar.
Crear campos por identificador de documento	Crea uno o varios campos en un documento y los asigna a los participantes. Para crear un único campo, proporcione un elemento en la matriz Fields. Para crear varios campos, proporcione varios elementos.
Crear documento por identificador de sobre	Carga un documento en un sobre nitro sign existente. El documento se puede usar más adelante en el flujo de trabajo de firma.
Crear participantes por identificador de sobre	Agrega uno o más participantes a un sobre Nitro Sign. Para agregar un solo participante, proporcione un elemento en la matriz Participantes. Para agregar varios participantes, proporcione varios elementos.
Crear sobre	Crea un nuevo sobre Nitro Sign que se puede rellenar posteriormente con documentos, participantes, campos y enviados para la firma.
Descargar documento sellado por identificador	Descarga un único documento firmado sellado de un sobre Nitro Sign como un archivo PDF.
Descargar registro de auditoría de sobre	Descarga el archivo PDF que contiene la pista de auditoría completa para el sobre Nitro Sign seleccionado.
Descargar sobre original	Descarga los documentos originales sin firmar de un sobre Nitro Sign como un archivo ZIP.
Descargar sobre sellado	Descarga los documentos firmados sellados desde un sobre Nitro Sign, junto con la pista de auditoría, como un archivo ZIP.
Eliminar campo por identificador	Elimina permanentemente un campo de un documento dentro de un sobre Nitro Sign.
Eliminar documento por identificador	Elimina permanentemente un documento de un sobre Nitro Sign.
Eliminar participante por identificador	Elimina permanentemente a un participante de un sobre Nitro Sign.
Eliminar sobre por identificador	Elimina permanentemente un sobre Nitro Sign. Esta operación no se puede deshacer y también se eliminan todos los documentos, campos y participantes asociados.
Enumerar campos por identificador de documento	Recupera todos los campos asociados a un documento específico dentro de un sobre nitro sign.
Enumerar documentos por identificador de sobre	Recupera todos los documentos asociados a un sobre nitro sign específico.
Enumerar participantes por identificador de sobre	Recupera todos los participantes asociados a un sobre nitro sign específico.
Enviar recordatorios para sobre	Desencadena notificaciones de recordatorio a los participantes pendientes de un sobre Nitro Sign especificado. Si no se proporciona ninguna configuración de notificación, se usa la plantilla de notificación predeterminada configurada para el sobre.
Envío de sobre para la firma	Envía un sobre Nitro Sign a los participantes para la recopilación de firmas. Antes de usar esta acción, el sobre normalmente debe tener documentos, participantes y campos de firma agregados mediante Create Document by Envelope ID, Create Participant(s) by Envelope ID y Create Field(s) by Document ID (Crear documento por id. de documento). Todos los documentos del sobre deben tener un estado cargado antes de que se pueda enviar el sobre.
Obtener documento por identificador	Recupera los detalles de un documento específico en un sobre nitro sign.
Obtener sobre por identificador	Recupera los detalles de un sobre nitro sign específico con su identificador de sobre único.
Reordenar documentos por identificador de sobre	Reordena los documentos asociados a un sobre Nitro Sign específico en función de la lista proporcionada de identificadores de documento.
Sobres de lista	El punto de conexión List Envelopes devuelve todos los sobres asociados a una aplicación de una cuenta.

Actualizar campo por identificador

Id. de la operación:: UpdateFieldByID

Actualiza las propiedades de un campo existente en un documento de signo nitro. El tipo de campo debe proporcionarse y debe coincidir con el tipo de campo existente; la API la usa para identificar el esquema de campo y no cambia el tipo de campo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el documento.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento que contiene el campo.
ID de campo	fieldID	True	uuid	UUID único que identifica el campo que se va a actualizar.
Tipo de campo	type	True	string	Tipo actual del campo que se está actualizando. La API requiere este valor y debe coincidir con el tipo de campo existente; no cambia el tipo de campo.
Id. de participante	participantID		uuid	Identificador único del participante asignado al campo.
Página	page		integer	Número de página donde aparece el campo. Las páginas usan la indexación basada en 1.
Posición X	x		float	Optional. Posición horizontal del campo, medida desde el borde izquierdo de la página en puntos.
Posición Y	y		float	Optional. Posición vertical del campo, medida desde el borde superior de la página en puntos.
Ancho	width		float	Optional. Ancho del campo en puntos.
Altura	height		float	Optional. Alto del campo en puntos.
Required	required		boolean	Indica si el participante debe completar este campo.
Format	format		string	Formato de campo, si procede. Por ejemplo, los campos de fecha pueden usar un formato como MM/DD/AAAA.
Modificable	modifiable		boolean	Indica si el valor del campo es modificable, si procede.

Devoluciones

Detalles del campo Nitro Sign.

Body: FieldResponse

Actualizar documento por identificador

Id. de la operación:: UpdateDocumentByID

Actualiza los metadatos de un documento existente dentro de un sobre Nitro Sign. Actualmente, solo se puede actualizar el nombre del documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el documento.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento que se va a actualizar.
Nombre del documento	name	True	string	Nuevo nombre para el documento.

Devoluciones

Detalles del documento Nitro Sign.

Body: DocumentResponse

Actualizar participante por identificador

Id. de la operación:: UpdateParticipantByID

Actualiza la configuración de autenticación de un participante en un sobre Nitro Sign. No se puede actualizar el correo electrónico del participante.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el participante.
Id. de participante	participantID	True	uuid	UUID único que identifica al participante que se va a actualizar.
Tipo de autenticación	type		string	Optional. Seleccione un método de autenticación para el participante. Si se especifica, también se debe proporcionar un código de acceso.
Código de acceso	accessCode		string	Solo se requiere cuando se especifica el tipo de autenticación. Deje en blanco si no se requiere la autenticación de participantes.

Devoluciones

Detalles del participante de Nitro Sign.

Body: ParticipantResponse

Actualizar sobre

Id. de la operación:: UpdateEnvelope

Actualiza un sobre nitro sign existente. Puede modificar el nombre del sobre, la configuración de notificación, el modo de firma o cualquier combinación de estos campos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que se va a actualizar.
Nombre del sobre	name		string	Nombre del sobre actualizado. No tiene que ser único.
Asunto de notificación	subject		string	Línea de asunto de la notificación por correo electrónico enviada a los participantes de firma. Se admiten variables dinámicas, por ejemplo: $(sender_name_or_email) solicita la firma.
Cuerpo de notificación	body		string	Cuerpo del correo electrónico enviado a los participantes de firma. Se admiten variables dinámicas, por ejemplo: Hola,\nFirme el\n$(envelope_name) Gracias,\n$(sender_name_or_email).
Modo de firma	mode		string	Define el orden de firma. Use paralelo para notificar a todos los participantes al mismo tiempo o secuencial para notificar a los participantes uno por uno en el orden en que se agregaron.

Devoluciones

Respuesta devuelta después de solicitar o crear un sobre Nitro Sign.

Body: EnvelopeResponse

Cancelar sobre por identificador

Id. de la operación:: CancelEnvelopeByID

Cancela la solicitud de firma de un sobre Nitro Sign. Solo se pueden cancelar los sobres que se han enviado para firmar.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que se va a cancelar.

Devoluciones

Respuesta devuelta después de solicitar o crear un sobre Nitro Sign.

Body: EnvelopeResponse

Crear campos por identificador de documento

Id. de la operación:: CreateFieldsByDocumentID

Crea uno o varios campos en un documento y los asigna a los participantes. Para crear un único campo, proporcione un elemento en la matriz Fields. Para crear varios campos, proporcione varios elementos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento donde se deben crear los campos.
Id. de participante	participantID	True	uuid	Identificador único del participante asignado al campo.
Página	page	True	integer	Número de página donde se debe colocar el campo. Las páginas usan la indexación basada en 1, por lo que la primera página es 1.
Tipo de campo	type	True	string	Tipo de campo que se va a crear.
Posición X	x	True	float	Posición horizontal del campo, medida desde el borde izquierdo de la página en puntos.
Posición Y	y	True	float	Posición vertical del campo, medida desde el borde superior de la página en puntos.
Ancho	width	True	float	Ancho del campo en puntos.
Altura	height	True	float	Alto del campo en puntos.
Required	required		boolean	Indica si el participante debe completar este campo.
Format	format		string	Formato opcional para los tipos de campo que admiten el formato, por ejemplo, campos de fecha. Ejemplo: MM/DD/AAAA.
Modificable	modifiable		boolean	Indica si el participante puede modificar el valor del campo, donde es compatible con el tipo de campo.

Devoluciones

Respuesta devuelta después de crear uno o varios campos.

Body: FieldsResponse

Crear documento por identificador de sobre

Id. de la operación:: CreateDocumentByEnvelopeID

Carga un documento en un sobre nitro sign existente. El documento se puede usar más adelante en el flujo de trabajo de firma.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre donde se cargará el documento.
Nombre del documento	documentName	True	string	Nombre del documento que se va a cargar. Este valor se usará para compilar los metadatos del documento enviados a Nitro.
Tipo de contenido	contentType		string	Tipo de contenido del documento cargado. Para los archivos PDF, use application/pdf. Cuando se omite de los metadatos, solo se aceptan archivos PDF.
Archivo de documento	payload	True	file	Archivo de documento que se va a cargar en el sobre.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Id. de documento	ID	uuid	UUID único que identifica el documento cargado.
Nombre del documento	name	string	Nombre del documento cargado.
Fecha de creación	createdAt	string	Marca de tiempo que indica cuándo se creó el documento.
Estado del documento	status	string	Estado de procesamiento del documento cargado.

Crear participantes por identificador de sobre

Id. de la operación:: CreateParticipantsByEnvelopeID

Agrega uno o más participantes a un sobre Nitro Sign. Para agregar un solo participante, proporcione un elemento en la matriz Participantes. Para agregar varios participantes, proporcione varios elementos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre donde se deben agregar los participantes.
Email	email	True	email	Dirección de correo electrónico del participante.
Función	role	True	string	Rol participante. Un firmante puede tener campos asignados para la firma. Un participante cc tiene acceso de solo lectura.
Tipo de autenticación	type		string	Optional. Seleccione un método de autenticación para el participante. Si se especifica, también se debe proporcionar un código de acceso.
Código de acceso	accessCode		string	Solo se requiere cuando se especifica el tipo de autenticación. Deje en blanco si no se requiere la autenticación de participantes.

Devoluciones

Respuesta devuelta después de crear uno o varios participantes.

Body: ParticipantsResponse

Crear sobre

Id. de la operación:: CreateEnvelope

Crea un nuevo sobre Nitro Sign que se puede rellenar posteriormente con documentos, participantes, campos y enviados para la firma.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Nombre del sobre	name	True	string	Nombre del sobre. No tiene que ser único.
Modo de firma	mode	True	string	Define el orden de firma. Use paralelo para notificar a todos los participantes al mismo tiempo o secuencial para notificar a los participantes uno por uno en el orden en que se agregaron.
Asunto de notificación	subject	True	string	Línea de asunto de la notificación por correo electrónico enviada a los participantes de firma. Se admiten variables dinámicas, por ejemplo: $(sender_name_or_email) solicita la firma.
Cuerpo de notificación	body	True	string	Cuerpo del correo electrónico enviado a los participantes de firma. Se admiten variables dinámicas, por ejemplo: Hola,\nFirme el\n$(envelope_name) Gracias,\n$(sender_name_or_email).

Devoluciones

Respuesta devuelta después de solicitar o crear un sobre Nitro Sign.

Body: EnvelopeResponse

Descargar documento sellado por identificador

Id. de la operación:: DownloadSealedDocumentByID

Descarga un único documento firmado sellado de un sobre Nitro Sign como un archivo PDF.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el documento sellado.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento sellado que se va a descargar.

Devoluciones

Archivo descargado encapsulado como sobre JSON.

Body: FileDownloadResponse

Descargar registro de auditoría de sobre

Id. de la operación:: DownloadAuditTrailOfEnvelope

Descarga el archivo PDF que contiene la pista de auditoría completa para el sobre Nitro Sign seleccionado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre cuya pista de auditoría se debe descargar.

Devoluciones

Archivo descargado encapsulado como sobre JSON.

Body: FileDownloadResponse

Descargar sobre original

Id. de la operación:: DownloadOriginalEnvelope

Descarga los documentos originales sin firmar de un sobre Nitro Sign como un archivo ZIP.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre cuyos documentos originales se deben descargar.

Devoluciones

Archivo descargado encapsulado como sobre JSON.

Body: FileDownloadResponse

Descargar sobre sellado

Id. de la operación:: DownloadSealedEnvelope

Descarga los documentos firmados sellados desde un sobre Nitro Sign, junto con la pista de auditoría, como un archivo ZIP.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre cuyos documentos sellados se deben descargar.

Devoluciones

Archivo descargado encapsulado como sobre JSON.

Body: FileDownloadResponse

Eliminar campo por identificador

Id. de la operación:: DeleteFieldByID

Elimina permanentemente un campo de un documento dentro de un sobre Nitro Sign.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el documento.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento que contiene el campo.
ID de campo	fieldID	True	uuid	UUID único que identifica el campo que se va a eliminar.

Eliminar documento por identificador

Id. de la operación:: DeleteDocumentByID

Elimina permanentemente un documento de un sobre Nitro Sign.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el documento.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento que se va a eliminar.

Eliminar participante por identificador

Id. de la operación:: DeleteParticipantByID

Elimina permanentemente a un participante de un sobre Nitro Sign.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el participante.
Id. de participante	participantID	True	uuid	UUID único que identifica al participante que se va a eliminar.

Eliminar sobre por identificador

Id. de la operación:: DeleteEnvelopeByID

Elimina permanentemente un sobre Nitro Sign. Esta operación no se puede deshacer y también se eliminan todos los documentos, campos y participantes asociados.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que se va a eliminar.

Enumerar campos por identificador de documento

Id. de la operación:: ListFieldsByDocumentID

Recupera todos los campos asociados a un documento específico dentro de un sobre nitro sign.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el documento.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento cuyos campos se deben recuperar.

Devoluciones

Respuesta devuelta después de crear uno o varios campos.

Body: FieldsResponse

Enumerar documentos por identificador de sobre

Id. de la operación:: ListDocumentsByEnvelopeID

Recupera todos los documentos asociados a un sobre nitro sign específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre cuyos documentos se deben recuperar.

Devoluciones

Respuesta devuelta al enumerar documentos asociados a un sobre Nitro Sign.

Body: ListDocumentsByEnvelopeIDResponse

Enumerar participantes por identificador de sobre

Id. de la operación:: ListParticipantsByEnvelopeID

Recupera todos los participantes asociados a un sobre nitro sign específico.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre cuyos participantes deben recuperarse.

Devoluciones

Respuesta devuelta al enumerar a los participantes asociados a un sobre Nitro Sign.

Body: ParticipantsListResponse

Enviar recordatorios para sobre

Id. de la operación:: SendRemindersForEnvelope

Desencadena notificaciones de recordatorio a los participantes pendientes de un sobre Nitro Sign especificado. Si no se proporciona ninguna configuración de notificación, se usa la plantilla de notificación predeterminada configurada para el sobre.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre para el que se deben enviar las notificaciones de recordatorio.
Asunto de notificación	subject		string	Línea de asunto de la notificación por correo electrónico enviada a los participantes de firma. Se admiten variables dinámicas, por ejemplo: $(sender_name_or_email) solicita la firma.
Cuerpo de notificación	body		string	Cuerpo del correo electrónico enviado a los participantes de firma. Se admiten variables dinámicas, por ejemplo: Hola,\nFirme el\n$(envelope_name) Gracias,\n$(sender_name_or_email).

Envío de sobre para la firma

Id. de la operación:: SendEnvelopeForSigning

Envía un sobre Nitro Sign a los participantes para la recopilación de firmas. Antes de usar esta acción, el sobre normalmente debe tener documentos, participantes y campos de firma agregados mediante Create Document by Envelope ID, Create Participant(s) by Envelope ID y Create Field(s) by Document ID (Crear documento por id. de documento). Todos los documentos del sobre deben tener un estado cargado antes de que se pueda enviar el sobre.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que se va a enviar para la firma.

Devoluciones

Información de resumen sobre un sobre Nitro Sign.

Body: EnvelopeSummaryResponse

Obtener documento por identificador

Id. de la operación:: GetDocumentByID

Recupera los detalles de un documento específico en un sobre nitro sign.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que contiene el documento.
Id. de documento	documentID	True	uuid	UUID único que identifica el documento que se va a recuperar.

Devoluciones

Detalles del documento Nitro Sign.

Body: DocumentResponse

Obtener sobre por identificador

Id. de la operación:: GetEnvelopeByID

Recupera los detalles de un sobre nitro sign específico con su identificador de sobre único.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre que se va a recuperar.

Devoluciones

Respuesta devuelta después de solicitar o crear un sobre Nitro Sign.

Body: EnvelopeResponse

Reordenar documentos por identificador de sobre

Id. de la operación:: ReorderDocumentsByEnvelopeID

Reordena los documentos asociados a un sobre Nitro Sign específico en función de la lista proporcionada de identificadores de documento.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sobre	envelopeID	True	uuid	UUID único que identifica el sobre cuyos documentos se deben reordenar.
ID de documento	order	True	array of uuid	Matriz de identificadores de documento que representan el nuevo orden de los documentos dentro del sobre.

Devoluciones

Respuesta devuelta al enumerar documentos asociados a un sobre Nitro Sign.

Body: ListDocumentsByEnvelopeIDResponse

Sobres de lista

Id. de la operación:: ListEnvelopes

El punto de conexión List Envelopes devuelve todos los sobres asociados a una aplicación de una cuenta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Página después	pageAfter		string	Token de cursor opcional que se usa para recuperar la página siguiente de sobres. Use el valor nextPage devuelto por la respuesta anterior.
Página anterior	pageBefore		string	Token de cursor opcional usado para recuperar la página anterior de sobres. No use junto con Page After.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Sobres	items	array of EnvelopeSummaryResponse	Lista de sobres.
Página siguiente	nextPage	string	Token de cursor que se puede usar como página después para recuperar la página siguiente de sobres.

Definiciones

EnvelopeNotification

Configuración de correo electrónico de notificación para un sobre Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
Asunto de notificación	subject	string	Línea de asunto de la notificación por correo electrónico enviada a los participantes de firma. Se admiten variables dinámicas, por ejemplo: $(sender_name_or_email) solicita la firma.
Cuerpo de notificación	body	string	Cuerpo del correo electrónico enviado a los participantes de firma. Se admiten variables dinámicas, por ejemplo: Hola,\nFirme el\n$(envelope_name) Gracias,\n$(sender_name_or_email).

EnvelopeSummaryResponse

Información de resumen sobre un sobre Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
Id. de sobre	ID	uuid	UUID único que identifica el sobre.
Fecha de creación	createdAt	date-time	Marca de tiempo UTC que indica cuándo se creó el sobre.
Última modificación en	lastModifiedAt	date-time	Marca de tiempo UTC que indica cuándo se modificó por última vez el sobre.
Nombre del sobre	name	string	Nombre del sobre.
Estado del sobre	status	string	Estado interno del sobre.

EnvelopeResponse

Respuesta devuelta después de solicitar o crear un sobre Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
Id. de sobre	ID	uuid	UUID único que identifica el sobre.
Fecha de creación	createdAt	date-time	Marca de tiempo UTC que indica cuándo se creó el sobre.
Última modificación en	lastModifiedAt	date-time	Marca de tiempo UTC que indica cuándo se modificó por última vez el sobre.
Nombre del sobre	name	string	Nombre del sobre.
Estado del sobre	status	string	Estado interno del sobre.
Modo de firma	mode	string	Modo de firma configurado para el sobre.
notificación	notification	EnvelopeNotification	Configuración de correo electrónico de notificación para un sobre Nitro Sign.

ListDocumentsByEnvelopeIDResponse

Respuesta devuelta al enumerar documentos asociados a un sobre Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
Documentos	items	array of DocumentResponse	Lista de documentos asociados al sobre.

DocumentResponse

Detalles del documento Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
Id. de documento	ID	uuid	UUID único que identifica el documento.
Nombre del documento	name	string	Nombre del documento.
Fecha de creación	createdAt	date-time	Marca de tiempo UTC que indica cuándo se creó el documento.
Tamaño en bytes	sizeBytes	integer	Tamaño del documento en bytes.
Número de páginas	numPages	integer	Número de páginas del documento.
Estado del documento	status	string	Estado actual del documento.

FieldsResponse

Respuesta devuelta después de crear uno o varios campos.

Nombre	Ruta de acceso	Tipo	Description
Fields	items	array of FieldResponse	Los campos creados en esta solicitud.

FieldResponse

Detalles del campo Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
ID de campo	ID	uuid	UUID único que identifica el campo.
Id. de participante	participantID	uuid	Identificador único del participante asignado al campo.
Id. de documento	documentID	uuid	Identificador único del documento al que pertenece el campo.
Página	page	integer	Número de página donde aparece el campo.
Cuadro de límite	boundingBox	array of float	Matriz de cuatro números con el formato [x, y, width, height], medido en puntos.
Required	required	boolean	Indica si el participante debe completar este campo.
Tipo de campo	type	string	El tipo de campo.
Format	format	string	Formato de campo, si procede.
Modificable	modifiable	boolean	Indica si el valor del campo es modificable, si procede.

ParticipantesResponse

Respuesta devuelta después de crear uno o varios participantes.

Nombre	Ruta de acceso	Tipo	Description
Participants	items	array of ParticipantResponse	Los participantes creados en esta solicitud.

ParticipantsListResponse

Respuesta devuelta al enumerar a los participantes asociados a un sobre Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
Participants	items	array of ParticipantResponse	Los participantes asociados al sobre.
Total de participantes	total	integer	Número total de participantes disponibles en la colección.

ParticipantResponse

Detalles del participante de Nitro Sign.

Nombre	Ruta de acceso	Tipo	Description
Id. de participante	ID	uuid	UUID único que identifica al participante.
Email	email	email	Dirección de correo electrónico del participante.
Función	role	string	Rol del participante.
authentication	authentication	ParticipantAuthenticationResponse	Configuración de autenticación devuelta para un participante.

ParticipantAuthenticationResponse

Configuración de autenticación devuelta para un participante.

Nombre	Ruta de acceso	Tipo	Description
Tipo de autenticación	type	string	Tipo de autenticación de participante.
Código de acceso	accessCode	string	Código de acceso configurado para el participante.

FileDownloadResponse

Archivo descargado encapsulado como sobre JSON.

Nombre	Ruta de acceso	Tipo	Description
Nombre del archivo	fileName	string	Nombre del archivo descargado, derivado del encabezado Content-Disposition de respuesta (por ejemplo, result.zip o result.pdf). Coloque este token directamente en la entrada Nombre de archivo de una acción de bajada, como OneDrive o SharePoint Crear archivo.
Tipo de contenido de archivo	fileContentType	string	El tipo MIME del archivo descargado, por ejemplo, application/zip o application/pdf.
Contenido del archivo	fileContent	byte	Contenido del archivo codificado en base64. Coloque este token directamente en la entrada De contenido del archivo de una acción de bajada (por ejemplo, OneDrive o SharePoint Crear archivo u otra acción Nitro): no se requiere ninguna expresión.