Nitro Sign (anteprima)

L'API Nitro Sign consente flussi di lavoro eSignature sicuri e end-to-end consentendo alle applicazioni di creare, gestire e tenere traccia dei processi di firma digitale. Offre funzionalità per creare buste, caricare documenti, aggiungere partecipanti, definire l'ordine di firma e inviare documenti per la firma tramite un approccio basato sulle API completamente automatizzato.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Service	Class	Regions
Copilot Studio	Premium	Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Standard	Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Premium	Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Premium	Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Nome	Supporto di Nitro
URL	https://www.gonitro.com/support
Posta elettronica	prosupport@sfdc.gonitro.com

Metadati del connettore
Publisher	Nitro PDF
Sito web	https://www.gonitro.com/
Informativa sulla privacy	https://www.gonitro.com/legal/privacy-policy
Categorie	Produttività; Operazioni IT

Nitro Sign Connector

Informazioni generali

Il connettore Nitro Sign consente flussi di lavoro eSignature end-to-end sicuri direttamente da Power Automate e Power Apps. Consente alle applicazioni di creare e gestire buste di firma, caricare e riordinare documenti, aggiungere partecipanti e definire l'ordine di firma, inserire campi di firma e dati, inviare documenti per firma, tenere traccia dello stato e scaricare i file originali, sealed e audit-trail, tutto tramite un approccio completamente automatizzato basato sulle API.

Publisher: Nitro Software

Prerequisites

Per usare Nitro Sign through this connector, è necessario:

Un account Nitro con Nitro Sign abilitato
https://developers.gonitro.com/
Piano di Microsoft PowerApps o Power Automate con le funzionalità di Custom Connector.

Authentication

Nitro Sign usa OAuth 2.0 da computer a computer con la concessione delle credenziali client per generare token di accesso per le richieste API.

Come funziona

Si crea un'applicazione API nel portale self-service di Nitro e si ottengono l'ID client e il segreto client associati.
Il connettore esegue l'autenticazione scambiando queste credenziali per un token di accesso bearer .
Il token viene quindi usato per autorizzare le successive chiamate API Nitro Sign.

Creare credenziali e leggere la guida dettagliata:
https://developers.gonitro.com/docs/authentication/credentials

Creazione di una connessione in Power Automate/Power Apps

Quando si aggiunge il connettore a un flusso o a un'app:

Fare clic su Aggiungi una nuova connessione.
Immettere l'ID client e il segreto client (rilasciati nel portale per sviluppatori Nitro).
Selezionare l'areaNitro (Europa, Stati Uniti o APAC), ovvero l'area associata all'account Nitro.
Salvare la connessione: al primo utilizzo, il connettore scambia l'ID client e il segreto client per un token di accesso di breve durata usando la concessione delle credenziali client OAuth 2.0, la memorizza nella cache e la rinnova automaticamente. Le credenziali vengono usate solo per ottenere il token; le chiamate API successive vengono autenticate con un token di connessione per conto dell'utente.

Nota: non è necessario alcun accesso interattivo per l'utente; questo flusso è progettato per scenari da server a server/da app a app.

Operazioni supportate

Il connettore raggruppa le azioni relative alle quattro risorse di un flusso di lavoro di firma, ovvero buste, documenti, campi e partecipanti , oltre a un set di azioni di download per il recupero di file completati.

1. Buste

Una busta è il contenitore per i documenti, i partecipanti e i campi in una singola richiesta di firma.

List Envelopes
Restituisce tutte le buste associate all'applicazione nell'account. I risultati sono impaginati: la risposta include un token del cursore pagina successiva, che è possibile fornire al parametro Facoltativo Page After per recuperare la pagina successiva (o Pagina prima della pagina all'indietro). Entrambi i parametri del cursore sono in Avanzate e sono necessari solo quando si passa attraverso set di risultati di grandi dimensioni.
Crea busta
Crea una nuova busta con un nome, un messaggio di notifica (oggetto + corpo, con variabili dinamiche come $(sender_name_or_email) e $(envelope_name)) e la modalità di firma:
- parallel — tutti i partecipanti ricevono una notifica contemporaneamente e possono firmare in modo indipendente.
- sequential — i partecipanti ricevono una notifica uno alla volta, nell'ordine in cui sono stati aggiunti.
Ottenere envelope per ID
Recupera i dettagli per una busta specifica in base al relativo UUID.
Aggiorna busta
Aggiorna il nome della busta, le impostazioni di notifica e/o la modalità di firma. Tutti i campi sono facoltativi.
Elimina busta per ID
Elimina definitivamente una busta e tutti i documenti, i campi e i partecipanti associati. Non è possibile annullare l'operazione.
Invia busta per la firma
Invia la busta ai partecipanti per la raccolta di firme. Prima dell'invio, la busta deve in genere contenere documenti, partecipanti e campi di firma aggiunti (tramite Crea documento per ID busta, Crea partecipante per ID busta e Crea campi in base all'ID documento). Tutti i documenti nella busta devono avere uno stato caricato prima che la busta possa essere inviata.
Invia promemoria per envelope
Attiva le notifiche di promemoria ai partecipanti in sospeso. Se non vengono specificate impostazioni di notifica, viene usato il modello di notifica predefinito configurato per la busta.
Annulla busta per ID
Annulla la richiesta di firma. Solo le buste che sono già state inviate per la firma possono essere annullate.

2. Documenti

I documenti sono i file allegati a una busta e firmati dai partecipanti.

Elencare i documenti in base all'ID busta
Recupera tutti i documenti associati a una busta.
Creare un documento in base all'ID busta
Carica un documento in una busta esistente. Specificare il file più campi semplici tipizzato, senza JSON scritto a mano:
- File di documento : il file da caricare.
- Nome documento : nome in cui archiviare il documento.
- Tipo di contenuto(avanzato, facoltativo) - tipo MIME del file; il valore predefinito è application/pdf. Se omesso, vengono accettati solo i file PDF.
Ottenere il documento in base all'ID
Recupera i dettagli per un documento specifico in una busta.
Aggiornare il documento in base all'ID
Aggiorna i metadati del documento. Attualmente è possibile modificare solo il nome del documento.
Elimina documento in base all'ID
Elimina definitivamente un documento da una busta.
Riordinare i documenti in base all'ID busta
Riordina i documenti in una busta in base a un elenco fornito di ID documento.

3. Campi

I campi sono gli elementi interattivi (firma, iniziali, data e così via) inseriti in un documento e assegnati a un partecipante.

Elencare i campi in base all'ID documento
Recupera tutti i campi associati a un documento specifico.
Creare campi in base all'ID documento
Crea uno o più campi in un documento e li assegna ai partecipanti. Specificare un elemento per un singolo campo o più elementi per una richiesta in blocco. Ogni campo specifica:
- participantID — il partecipante assegnato al campo.
- type— uno di signature, initials, namedate, title, company, checkboxcustom.
- page — numero di pagina (indicizzazione basata su 1).
- Posizione X, Posizione Y, Larghezza, Altezza : posizione e dimensioni del campo, ognuna immessa come numero separato in punti (X/Y viene misurata dal bordo sinistro/superiore della pagina). Questi sostituiscono la matrice singola boundingBox precedente, quindi ogni valore è un campo tipizzato nell'interfaccia utente anziché un elenco compilato a mano.
- Facoltativo: required (impostazione predefinita true) e - in Avanzate ( format ad esempio MM/DD/YYYY per i campi data) e modifiable.
Aggiorna campo per ID
Aggiorna le proprietà di un campo esistente. Il campo type deve essere specificato e deve corrispondere al tipo di campo esistente, che viene usato per identificare lo schema del campo e non modifica il tipo di campo.
Elimina campo per ID
Elimina definitivamente un campo da un documento.

4. Partecipanti

I partecipanti sono le persone che ricevono la busta, sia per firmarlo che per essere tenuti informati.

Elencare i partecipanti per ID busta
Recupera tutti i partecipanti associati a una busta.
Creare partecipanti per ID busta
Aggiunge uno o più partecipanti a una busta. Specificare un elemento per un singolo partecipante o più elementi per una richiesta in blocco. Ogni partecipante specifica:
- email — indirizzo di posta elettronica del partecipante.
- role — signer (può avere campi assegnati per la firma) o cc (accesso in sola lettura).
- authentication (avanzato, facoltativo):codice di accesso: un codice di accesso statico che il partecipante deve fornire prima della firma. Aprire questa sezione solo se il partecipante deve eseguire l'autenticazione prima della firma.
Aggiornare il partecipante in base all'ID
Aggiorna le impostazioni di autenticazione di un partecipante. Impossibile modificare il messaggio di posta elettronica del partecipante.
Elimina partecipante per ID
Elimina definitivamente un partecipante da una busta.

5. Download

Recuperare i file completati dopo che i documenti sono stati firmati e sealed.

Scarica busta originale
Scarica i documenti originali non firmati da una busta come archivio ZIP .
Scarica busta sealed
Scarica i documenti firmati sealed, insieme al audit trail, come archivio ZIP .
Scarica documento sealed in base all'ID
Scarica un singolo documento firmato bloccato come file PDF .
Scarica Audit Trail of Envelope
Scarica il audit trail completo per una busta come file PDF .

Le azioni di download espongono token di file nativi enome file nativi (più tipo di contenuto file). Eliminare il contenuto del file direttamente nell'input del file di un passaggio downstream, ad esempio OneDrive/SharePoint Crea file e nome file nell'input del nome file. Non body('Action_Name') è necessaria alcuna espressione o un nome file tipizzato manualmente. Il connettore esegue il wrapping del file ZIP o PDF scaricato in una busta JSON, in modo che Power Automate li eseprima come token di contenuto dinamico ordinari.

Flusso di lavoro di firma tipico

Un flusso di firma completo concatena le azioni precedenti nell'ordine indicato. Un flusso di Power Automate comune è simile al seguente:

Crea busta : impostare il nome, l'oggetto o il corpo della notifica e la modalità di firma (parallel o sequential). Salvare l'ID busta restituito.
Crea documento per ID busta : carica uno o più file nella busta (usando l'ID busta del passaggio 1). Salvare ogni ID documento restituito.
(Facoltativo)Riordinare i documenti in base all'ID busta : impostare l'ordine del documento.
Creare partecipanti in base all'ID busta : aggiungere i firmatari e i destinatari cc con l'autenticazione con codice di accesso. Salvare ogni ID partecipante restituito.
Crea campi in base all'ID documento : inserisci i campi firma/data/e così via in ogni documento e assegnali ai partecipanti (usando l'ID documento del passaggio 2 e l'ID partecipante del passaggio 3).
Invia busta per la firma : invia la busta. Prima di tutto, tutti i documenti devono trovarsi nello stato caricato.
(In sospeso)Invia promemoria per envelope ai partecipanti nudge o Annulla busta per ID per arrestare la richiesta.
(Al termine)Scaricare sealed envelope / Download Sealed Document by ID / Download Audit Trail of Envelope per recuperare i file completati.

Suggerimento: l'ID busta, l'ID documento e l'ID partecipante restituiti dal flusso delle azioni di creazione naturalmente nelle azioni successive tramite la selezione contenuto dinamico di Power Automate, selezionare il token ID dall'azione upstream anziché digitarlo.

Errori e limitazioni

L'API Nitro Sign può restituire gli errori seguenti:

400 - Richiesta non valida
401 - Non autorizzato
404 - Non trovato
409 - Conflitto (ad esempio, che agisce su una busta in uno stato che non consente l'operazione)
413 - Contenuto troppo grande
415 - Tipo di supporto non supportato
422 - Entità non elaborabile
500 - Errore interno del server

Limitazione

Chiamate API per connessione: 100 per 60 secondi.

Limiti della piattaforma

Dimensioni file

Massimo: 25 MB per richiesta
Si applica sia alle operazioni a file singolo che a più file.

Conteggio pagine

Massimo: 250 pagine per singolo documento
Il totale delle pagine combinate tra più documenti può superare i 250.

Tempo di conservazione

I file di input e output vengono eliminati circa 15 minuti dopo il completamento dell'operazione.

Note

Le azioni di gestione busta, documento, campo e partecipante restituiscono JSON.
Le azioni di download restituiscono il file (ZIP o PDF) racchiuso in una busta JSON che espone il nome file, il tipo di contenuto file e il contenuto del file come token nativi di selezione, in modo che i risultati possano essere concatenati in un'azione di file downstream senza espressioni.
La modalità di firma (parallel vs sequential) viene impostata quando viene creata la busta e può essere modificata con Update Envelope prima dell'invio della busta.
L'autenticazione partecipante attualmente supporta solo il codice di accesso .

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:


Predefinita	Parametri per la creazione della connessione.	Tutte le aree geografiche	Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome	Tipo	Descrizione	Required
Nitro Client ID	securestring	ID client dell'applicazione Nitro	True
Nitro Client Secret	securestring	Segreto client dell'applicazione Nitro	True
Nitro Region	string	Selezionare l'area api Nitro per l'account.	True

Azioni

Aggiorna busta	Aggiorna una busta Nitro Sign esistente. È possibile modificare il nome della busta, le impostazioni di notifica, la modalità di firma o qualsiasi combinazione di questi campi.
Aggiorna campo per ID	Aggiorna le proprietà di un campo esistente in un documento Nitro Sign. Il tipo di campo deve essere specificato e deve corrispondere al tipo di campo esistente; viene usato dall'API per identificare lo schema del campo e non modifica il tipo di campo.
Aggiornare il documento in base all'ID	Aggiorna i metadati di un documento esistente all'interno di una busta Nitro Sign. Attualmente è possibile aggiornare solo il nome del documento.
Aggiornare il partecipante in base all'ID	Aggiorna le impostazioni di autenticazione per un partecipante in una busta Nitro Sign. Impossibile aggiornare il messaggio di posta elettronica del partecipante.
Annulla busta per ID	Annulla la richiesta di firma per una busta Nitro Sign. Solo le buste inviate per la firma possono essere annullate.
Crea busta	Crea una nuova busta Nitro Sign che in un secondo momento può essere popolata con documenti, partecipanti, campi e inviati per la firma.
Creare campi in base all'ID documento	Crea uno o più campi in un documento e li assegna ai partecipanti. Per creare un singolo campo, specificare un elemento nella matrice Fields. Per creare più campi, specificare più elementi.
Creare partecipanti per ID busta	Aggiunge uno o più partecipanti a una busta Nitro Sign. Per aggiungere un singolo partecipante, specificare un elemento nella matrice Partecipanti. Per aggiungere più partecipanti, specificare più elementi.
Creare un documento in base all'ID busta	Carica un documento in una busta Nitro Sign esistente. Il documento può essere usato successivamente nel flusso di lavoro di firma.
Elencare i campi in base all'ID documento	Recupera tutti i campi associati a un documento specifico all'interno di una busta Nitro Sign.
Elencare i documenti in base all'ID busta	Recupera tutti i documenti associati a una busta Nitro Sign specifica.
Elencare i partecipanti per ID busta	Recupera tutti i partecipanti associati a una busta Nitro Sign specifica.
Elimina busta per ID	Elimina definitivamente una busta Nitro Sign. Questa operazione non può essere annullata e vengono eliminati anche tutti i documenti, i campi e i partecipanti associati.
Elimina campo per ID	Elimina definitivamente un campo da un documento all'interno di una busta Nitro Sign.
Elimina documento in base all'ID	Elimina definitivamente un documento da una busta Nitro Sign.
Elimina partecipante per ID	Elimina definitivamente un partecipante da una busta Nitro Sign.
Invia busta per la firma	Invia una busta Nitro Sign ai partecipanti per la raccolta di firme. Prima di usare questa azione, la busta deve in genere contenere documenti, partecipanti e campi di firma aggiunti usando Crea documento per ID busta, Crea partecipante per ID busta e Crea campi in base all'ID documento. Tutti i documenti nella busta devono avere uno stato caricato prima che la busta possa essere inviata.
Invia promemoria per envelope	Attiva le notifiche di promemoria ai partecipanti in sospeso di una busta Nitro Sign specificata. Se non vengono specificate impostazioni di notifica, viene usato il modello di notifica predefinito configurato per la busta.
List Envelopes	L'endpoint List Envelopes restituisce tutte le buste associate a un'applicazione in un account.
Ottenere envelope per ID	Recupera i dettagli per una busta Nitro Sign specifica usando l'ID busta univoco.
Ottenere il documento in base all'ID	Recupera i dettagli per un documento specifico in una busta Nitro Sign.
Riordinare i documenti in base all'ID busta	Riordina i documenti associati a una busta Nitro Sign specifica in base all'elenco fornito di ID documento.
Scarica Audit Trail of Envelope	Scarica il file PDF contenente il audit trail completo per la busta Nitro Sign selezionata.
Scarica busta originale	Scarica i documenti originali non firmati da una busta Nitro Sign come archivio ZIP.
Scarica busta sealed	Scarica i documenti firmati sealed da una busta Nitro Sign, insieme al audit trail, come archivio ZIP.
Scarica documento sealed in base all'ID	Scarica un singolo documento firmato sealed da una busta Nitro Sign come file PDF.

Aggiorna busta

ID operazione:: UpdateEnvelope

Aggiorna una busta Nitro Sign esistente. È possibile modificare il nome della busta, le impostazioni di notifica, la modalità di firma o qualsiasi combinazione di questi campi.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta da aggiornare.
Nome busta	name		string	Nome della busta aggiornato. Non è necessario che sia univoco.
Oggetto notifica	subject		string	Riga dell'oggetto della notifica di posta elettronica inviata ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: $(sender_name_or_email) richiede la firma.
Corpo della notifica	body		string	Corpo del messaggio di posta elettronica inviato ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: Hi,\nFirmare il\n$(envelope_name) grazie,\n$(sender_name_or_email).
Modalità di firma	mode		string	Definisce l'ordine di firma. Usare parallela per notificare a tutti i partecipanti contemporaneamente o sequenziale per notificare ai partecipanti uno alla volta nell'ordine in cui sono stati aggiunti.

Valori restituiti

Risposta restituita dopo la richiesta o la creazione di una busta Nitro Sign.

Corpo: EnvelopeResponse

Aggiorna campo per ID

ID operazione:: UpdateFieldByID

Aggiorna le proprietà di un campo esistente in un documento Nitro Sign. Il tipo di campo deve essere specificato e deve corrispondere al tipo di campo esistente; viene usato dall'API per identificare lo schema del campo e non modifica il tipo di campo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il documento.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento contenente il campo.
ID del campo	fieldID	True	uuid	UUID univoco che identifica il campo da aggiornare.
Tipo di campo	type	True	string	Tipo corrente del campo da aggiornare. Questo valore è richiesto dall'API e deve corrispondere al tipo di campo esistente; non modifica il tipo di campo.
ID partecipante	participantID		uuid	Identificatore univoco del partecipante assegnato al campo.
Pagina	page		integer	Numero di pagina in cui viene visualizzato il campo. Le pagine usano l'indicizzazione basata su 1.
Posizione X	x		float	Optional. Posizione orizzontale del campo, misurata dal bordo sinistro della pagina in punti.
Posizione Y	y		float	Optional. Posizione verticale del campo, misurata dal bordo superiore della pagina in punti.
Larghezza	width		float	Optional. Larghezza del campo in punti.
Altezza	height		float	Optional. Altezza del campo in punti.
Required	required		boolean	Indica se il partecipante deve completare questo campo.
Format	format		string	Formato del campo, se applicabile. Ad esempio, i campi di data possono usare un formato, ad esempio MM/GG/AAAA.
Modificabile	modifiable		boolean	Indica se il valore del campo è modificabile, se applicabile.

Valori restituiti

Dettagli del campo Nitro Sign.

Corpo: FieldResponse

Aggiornare il documento in base all'ID

ID operazione:: UpdateDocumentByID

Aggiorna i metadati di un documento esistente all'interno di una busta Nitro Sign. Attualmente è possibile aggiornare solo il nome del documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il documento.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento da aggiornare.
Nome documento	name	True	string	Nuovo nome del documento.

Valori restituiti

Dettagli del documento Nitro Sign.

Corpo: DocumentResponse

Aggiornare il partecipante in base all'ID

ID operazione:: UpdateParticipantByID

Aggiorna le impostazioni di autenticazione per un partecipante in una busta Nitro Sign. Impossibile aggiornare il messaggio di posta elettronica del partecipante.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il partecipante.
ID partecipante	participantID	True	uuid	UUID univoco che identifica il partecipante da aggiornare.
Tipo di autenticazione	type		string	Optional. Selezionare un metodo di autenticazione per il partecipante. Se specificato, deve essere fornito anche un codice di accesso.
Codice di accesso	accessCode		string	Obbligatorio solo quando viene specificato il tipo di autenticazione. Lasciare vuoto se non è necessaria l'autenticazione dei partecipanti.

Valori restituiti

Dettagli del partecipante di Nitro Sign.

Corpo: ParticipantResponse

Annulla busta per ID

ID operazione:: CancelEnvelopeByID

Annulla la richiesta di firma per una busta Nitro Sign. Solo le buste inviate per la firma possono essere annullate.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta da annullare.

Valori restituiti

Risposta restituita dopo la richiesta o la creazione di una busta Nitro Sign.

Corpo: EnvelopeResponse

Crea busta

ID operazione:: CreateEnvelope

Crea una nuova busta Nitro Sign che in un secondo momento può essere popolata con documenti, partecipanti, campi e inviati per la firma.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Nome busta	name	True	string	Nome della busta. Non è necessario che sia univoco.
Modalità di firma	mode	True	string	Definisce l'ordine di firma. Usare parallela per notificare a tutti i partecipanti contemporaneamente o sequenziale per notificare ai partecipanti uno alla volta nell'ordine in cui sono stati aggiunti.
Oggetto notifica	subject	True	string	Riga dell'oggetto della notifica di posta elettronica inviata ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: $(sender_name_or_email) richiede la firma.
Corpo della notifica	body	True	string	Corpo del messaggio di posta elettronica inviato ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: Hi,\nFirmare il\n$(envelope_name) grazie,\n$(sender_name_or_email).

Valori restituiti

Risposta restituita dopo la richiesta o la creazione di una busta Nitro Sign.

Corpo: EnvelopeResponse

Creare campi in base all'ID documento

ID operazione:: CreateFieldsByDocumentID

Crea uno o più campi in un documento e li assegna ai partecipanti. Per creare un singolo campo, specificare un elemento nella matrice Fields. Per creare più campi, specificare più elementi.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento in cui devono essere creati i campi.
ID partecipante	participantID	True	uuid	Identificatore univoco del partecipante assegnato al campo.
Pagina	page	True	integer	Numero di pagina in cui deve essere posizionato il campo. Le pagine usano l'indicizzazione basata su 1, quindi la prima pagina è 1.
Tipo di campo	type	True	string	Tipo di campo da creare.
Posizione X	x	True	float	Posizione orizzontale del campo, misurata dal bordo sinistro della pagina in punti.
Posizione Y	y	True	float	Posizione verticale del campo, misurata dal bordo superiore della pagina in punti.
Larghezza	width	True	float	Larghezza del campo in punti.
Altezza	height	True	float	Altezza del campo in punti.
Required	required		boolean	Indica se il partecipante deve completare questo campo.
Format	format		string	Formato facoltativo per i tipi di campo che supportano la formattazione, ad esempio i campi data. Esempio: MM/GG/AAAA.
Modificabile	modifiable		boolean	Indica se il valore del campo può essere modificato dal partecipante, se supportato dal tipo di campo.

Valori restituiti

Risposta restituita dopo la creazione di uno o più campi.

Corpo: FieldsResponse

Creare partecipanti per ID busta

ID operazione:: CreateParticipantsByEnvelopeID

Aggiunge uno o più partecipanti a una busta Nitro Sign. Per aggiungere un singolo partecipante, specificare un elemento nella matrice Partecipanti. Per aggiungere più partecipanti, specificare più elementi.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta in cui devono essere aggiunti i partecipanti.
Posta elettronica	email	True	email	Indirizzo di posta elettronica del partecipante.
Ruolo	role	True	string	Ruolo partecipante. Un firmatario può avere campi assegnati per la firma. Un partecipante cc ha accesso in sola lettura.
Tipo di autenticazione	type		string	Optional. Selezionare un metodo di autenticazione per il partecipante. Se specificato, deve essere fornito anche un codice di accesso.
Codice di accesso	accessCode		string	Obbligatorio solo quando viene specificato il tipo di autenticazione. Lasciare vuoto se non è necessaria l'autenticazione dei partecipanti.

Valori restituiti

Risposta restituita dopo la creazione di uno o più partecipanti.

Corpo: ParticipantsResponse

Creare un documento in base all'ID busta

ID operazione:: CreateDocumentByEnvelopeID

Carica un documento in una busta Nitro Sign esistente. Il documento può essere usato successivamente nel flusso di lavoro di firma.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta in cui verrà caricato il documento.
Nome documento	documentName	True	string	Nome del documento da caricare. Questo valore verrà usato per compilare i metadati del documento inviati a Nitro.
Tipo di contenuto	contentType		string	Tipo di contenuto del documento caricato. Per i file PDF, usare application/pdf. Quando viene omesso dai metadati, vengono accettati solo i file PDF.
File documento	payload	True	file	File di documento da caricare nella busta.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
ID documento	ID	uuid	UUID univoco che identifica il documento caricato.
Nome documento	name	string	Nome del documento caricato.
Data di creazione	createdAt	string	Timestamp che indica quando è stato creato il documento.
Stato documento	status	string	Stato di elaborazione del documento caricato.

Elencare i campi in base all'ID documento

ID operazione:: ListFieldsByDocumentID

Recupera tutti i campi associati a un documento specifico all'interno di una busta Nitro Sign.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il documento.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento i cui campi devono essere recuperati.

Valori restituiti

Risposta restituita dopo la creazione di uno o più campi.

Corpo: FieldsResponse

Elencare i documenti in base all'ID busta

ID operazione:: ListDocumentsByEnvelopeID

Recupera tutti i documenti associati a una busta Nitro Sign specifica.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta i cui documenti devono essere recuperati.

Valori restituiti

Risposta restituita quando si elencano i documenti associati a una busta Nitro Sign.

Corpo: ListDocumentsByEnvelopeIDResponse

Elencare i partecipanti per ID busta

ID operazione:: ListParticipantsByEnvelopeID

Recupera tutti i partecipanti associati a una busta Nitro Sign specifica.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta i cui partecipanti devono essere recuperati.

Valori restituiti

Risposta restituita quando si elencano i partecipanti associati a una busta Nitro Sign.

Corpo: ParticipantsListResponse

Elimina busta per ID

ID operazione:: DeleteEnvelopeByID

Elimina definitivamente una busta Nitro Sign. Questa operazione non può essere annullata e vengono eliminati anche tutti i documenti, i campi e i partecipanti associati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta da eliminare.

Elimina campo per ID

ID operazione:: DeleteFieldByID

Elimina definitivamente un campo da un documento all'interno di una busta Nitro Sign.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il documento.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento contenente il campo.
ID del campo	fieldID	True	uuid	UUID univoco che identifica il campo da eliminare.

Elimina documento in base all'ID

ID operazione:: DeleteDocumentByID

Elimina definitivamente un documento da una busta Nitro Sign.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il documento.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento da eliminare.

Elimina partecipante per ID

ID operazione:: DeleteParticipantByID

Elimina definitivamente un partecipante da una busta Nitro Sign.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il partecipante.
ID partecipante	participantID	True	uuid	UUID univoco che identifica il partecipante da eliminare.

Invia busta per la firma

ID operazione:: SendEnvelopeForSigning

Invia una busta Nitro Sign ai partecipanti per la raccolta di firme. Prima di usare questa azione, la busta deve in genere contenere documenti, partecipanti e campi di firma aggiunti usando Crea documento per ID busta, Crea partecipante per ID busta e Crea campi in base all'ID documento. Tutti i documenti nella busta devono avere uno stato caricato prima che la busta possa essere inviata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta da inviare per la firma.

Valori restituiti

Riepilogo delle informazioni su una busta Nitro Sign.

Corpo: EnvelopeSummaryResponse

Invia promemoria per envelope

ID operazione:: SendRemindersForEnvelope

Attiva le notifiche di promemoria ai partecipanti in sospeso di una busta Nitro Sign specificata. Se non vengono specificate impostazioni di notifica, viene usato il modello di notifica predefinito configurato per la busta.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta per cui inviare le notifiche di promemoria.
Oggetto notifica	subject		string	Riga dell'oggetto della notifica di posta elettronica inviata ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: $(sender_name_or_email) richiede la firma.
Corpo della notifica	body		string	Corpo del messaggio di posta elettronica inviato ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: Hi,\nFirmare il\n$(envelope_name) grazie,\n$(sender_name_or_email).

List Envelopes

ID operazione:: ListEnvelopes

L'endpoint List Envelopes restituisce tutte le buste associate a un'applicazione in un account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina dopo	pageAfter		string	Token cursore facoltativo usato per recuperare la pagina successiva delle buste. Usare il valore nextPage restituito dalla risposta precedente.
Pagina prima	pageBefore		string	Token cursore facoltativo usato per recuperare la pagina precedente delle buste. Non usare insieme a Page After.

Valori restituiti

Nome	Percorso	Tipo	Descrizione
Buste	items	array of EnvelopeSummaryResponse	Elenco delle buste.
Pagina successiva	nextPage	string	Token cursore che può essere usato come Page After per recuperare la pagina successiva delle buste.

Ottenere envelope per ID

ID operazione:: GetEnvelopeByID

Recupera i dettagli per una busta Nitro Sign specifica usando l'ID busta univoco.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta da recuperare.

Valori restituiti

Risposta restituita dopo la richiesta o la creazione di una busta Nitro Sign.

Corpo: EnvelopeResponse

Ottenere il documento in base all'ID

ID operazione:: GetDocumentByID

Recupera i dettagli per un documento specifico in una busta Nitro Sign.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il documento.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento da recuperare.

Valori restituiti

Dettagli del documento Nitro Sign.

Corpo: DocumentResponse

Riordinare i documenti in base all'ID busta

ID operazione:: ReorderDocumentsByEnvelopeID

Riordina i documenti associati a una busta Nitro Sign specifica in base all'elenco fornito di ID documento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta i cui documenti devono essere riordinati.
ID dei documenti	order	True	array of uuid	Matrice di ID documento che rappresentano il nuovo ordine di documenti all'interno della busta.

Valori restituiti

Risposta restituita quando si elencano i documenti associati a una busta Nitro Sign.

Corpo: ListDocumentsByEnvelopeIDResponse

Scarica Audit Trail of Envelope

ID operazione:: DownloadAuditTrailOfEnvelope

Scarica il file PDF contenente il audit trail completo per la busta Nitro Sign selezionata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta il cui audit trail deve essere scaricato.

Valori restituiti

File scaricato di cui è stato eseguito il wrapping come busta JSON.

Corpo: FileDownloadResponse

Scarica busta originale

ID operazione:: DownloadOriginalEnvelope

Scarica i documenti originali non firmati da una busta Nitro Sign come archivio ZIP.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta i cui documenti originali devono essere scaricati.

Valori restituiti

File scaricato di cui è stato eseguito il wrapping come busta JSON.

Corpo: FileDownloadResponse

Scarica busta sealed

ID operazione:: DownloadSealedEnvelope

Scarica i documenti firmati sealed da una busta Nitro Sign, insieme al audit trail, come archivio ZIP.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta i cui documenti sealed devono essere scaricati.

Valori restituiti

File scaricato di cui è stato eseguito il wrapping come busta JSON.

Corpo: FileDownloadResponse

Scarica documento sealed in base all'ID

ID operazione:: DownloadSealedDocumentByID

Scarica un singolo documento firmato sealed da una busta Nitro Sign come file PDF.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID busta	envelopeID	True	uuid	UUID univoco che identifica la busta contenente il documento sealed.
ID documento	documentID	True	uuid	UUID univoco che identifica il documento sealed da scaricare.

Valori restituiti

File scaricato di cui è stato eseguito il wrapping come busta JSON.

Corpo: FileDownloadResponse

Definizioni

EnvelopeNotification

Impostazioni di posta elettronica di notifica per una busta Nitro Sign.

Nome	Percorso	Tipo	Descrizione
Oggetto notifica	subject	string	Riga dell'oggetto della notifica di posta elettronica inviata ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: $(sender_name_or_email) richiede la firma.
Corpo della notifica	body	string	Corpo del messaggio di posta elettronica inviato ai partecipanti alla firma. Le variabili dinamiche sono supportate, ad esempio: Hi,\nFirmare il\n$(envelope_name) grazie,\n$(sender_name_or_email).

EnvelopeSummaryResponse

Riepilogo delle informazioni su una busta Nitro Sign.

Nome	Percorso	Tipo	Descrizione
ID busta	ID	uuid	UUID univoco che identifica la busta.
Data di creazione	createdAt	date-time	Timestamp UTC che indica quando è stata creata la busta.
Data ultima modifica	lastModifiedAt	date-time	Timestamp UTC che indica l'ultima modifica della busta.
Nome busta	name	string	Nome della busta.
Stato busta	status	string	Stato interno della busta.

EnvelopeResponse

Risposta restituita dopo la richiesta o la creazione di una busta Nitro Sign.

Nome	Percorso	Tipo	Descrizione
ID busta	ID	uuid	UUID univoco che identifica la busta.
Data di creazione	createdAt	date-time	Timestamp UTC che indica quando è stata creata la busta.
Data ultima modifica	lastModifiedAt	date-time	Timestamp UTC che indica l'ultima modifica della busta.
Nome busta	name	string	Nome della busta.
Stato busta	status	string	Stato interno della busta.
Modalità di firma	mode	string	Modalità di firma configurata per la busta.
notifica	notification	EnvelopeNotification	Impostazioni di posta elettronica di notifica per una busta Nitro Sign.

ListDocumentsByEnvelopeIDResponse

Risposta restituita quando si elencano i documenti associati a una busta Nitro Sign.

Nome	Percorso	Tipo	Descrizione
Documents	items	array of DocumentResponse	Elenco di documenti associati alla busta.

DocumentResponse

Dettagli del documento Nitro Sign.

Nome	Percorso	Tipo	Descrizione
ID documento	ID	uuid	UUID univoco che identifica il documento.
Nome documento	name	string	Nome del documento.
Data di creazione	createdAt	date-time	Timestamp UTC che indica quando è stato creato il documento.
Dimensioni in byte	sizeBytes	integer	Dimensioni del documento in byte.
Numero di pagine	numPages	integer	Numero di pagine nel documento.
Stato documento	status	string	Stato corrente del documento.

FieldsResponse

Risposta restituita dopo la creazione di uno o più campi.

Nome	Percorso	Tipo	Descrizione
Fields	items	array of FieldResponse	Campi creati in questa richiesta.

FieldResponse

Dettagli del campo Nitro Sign.

Nome	Percorso	Tipo	Descrizione
ID del campo	ID	uuid	UUID univoco che identifica il campo.
ID partecipante	participantID	uuid	Identificatore univoco del partecipante assegnato al campo.
ID documento	documentID	uuid	Identificatore univoco del documento a cui appartiene il campo.
Pagina	page	integer	Numero di pagina in cui viene visualizzato il campo.
Riquadro	boundingBox	array of float	Matrice di quattro numeri nel formato [x, y, larghezza, altezza], misurata in punti.
Required	required	boolean	Indica se il partecipante deve completare questo campo.
Tipo di campo	type	string	Tipo di campo.
Format	format	string	Formato del campo, se applicabile.
Modificabile	modifiable	boolean	Indica se il valore del campo è modificabile, se applicabile.

PartecipantiResponse

Risposta restituita dopo la creazione di uno o più partecipanti.

Nome	Percorso	Tipo	Descrizione
Participants	items	array of ParticipantResponse	I partecipanti creati in questa richiesta.

ParticipantsListResponse

Risposta restituita quando si elencano i partecipanti associati a una busta Nitro Sign.

Nome	Percorso	Tipo	Descrizione
Participants	items	array of ParticipantResponse	Partecipanti associati alla busta.
Totale partecipanti	total	integer	Numero totale di partecipanti disponibili nella raccolta.

PartecipanteResponse

Dettagli del partecipante di Nitro Sign.

Nome	Percorso	Tipo	Descrizione
ID partecipante	ID	uuid	UUID univoco che identifica il partecipante.
Posta elettronica	email	email	Indirizzo di posta elettronica del partecipante.
Ruolo	role	string	Ruolo del partecipante.
authentication	authentication	ParticipantAuthenticationResponse	Impostazioni di autenticazione restituite per un partecipante.

ParticipantAuthenticationResponse

Impostazioni di autenticazione restituite per un partecipante.

Nome	Percorso	Tipo	Descrizione
Tipo di autenticazione	type	string	Tipo di autenticazione partecipante.
Codice di accesso	accessCode	string	Codice di accesso configurato per il partecipante.

FileDownloadResponse

File scaricato di cui è stato eseguito il wrapping come busta JSON.

Nome	Percorso	Tipo	Descrizione
Nome del file	fileName	string	Nome del file scaricato, derivato dall'intestazione Content-Disposition della risposta, ad esempio result.zip o result.pdf. Eliminare questo token direttamente nell'input Nome file di un'azione downstream, ad esempio OneDrive o SharePoint Crea file.
Tipo di contenuto file	fileContentType	string	Tipo MIME del file scaricato, ad esempio application/zip o application/pdf.
Contenuto del file	fileContent	byte	Contenuto del file con codifica Base64. Eliminare questo token direttamente nell'input Contenuto file di un'azione downstream (ad esempio OneDrive o SharePoint Crea file o un'altra azione Nitro) - nessuna espressione richiesta.