BlueInk

Il connettore Blueink consente di aggiungere la piattaforma eSignature di Blueink nei flussi di lavoro automatizzati. Il connettore consente di controllare lo stato del bundle, creare nuovi bundle, accedere alle informazioni sul firmatario e altro ancora.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Di alta qualità	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	Normale	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	Di alta qualità	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	Di alta qualità	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 Blueink
URL	https://help.blueink.com/en/
Email	support@blueink.com

Metadati del connettore
Editore	Blueink
Sito web	https://blueink.com
Informativa sulla privacy	https://blueink.com/privacy-policy/
Categorie	Gestione aziendale; Produttività

Con questo connettore versatile, gli utenti possono integrare facilmente la potente soluzione eSignature di Blueink nel flusso di lavoro sfruttando le funzionalità di vari connettori di Power Automate. Questa integrazione consente agli utenti di automatizzare facilmente la creazione e la distribuzione dei bundle di documenti. Orchestrando l'interazione armonica di questo connettore con altri connettori, è possibile semplificare i processi di gestione dei documenti, migliorare l'efficienza e garantire un'esperienza di firma dei documenti trasparente ed efficiente per i clienti e gli stakeholder. Che si tratti di automatizzare le approvazioni dei contratti, l'elaborazione di documenti legali o la gestione di documenti cartacei in qualsiasi altro contesto, questo connettore offre uno strumento potente per ottimizzare il flusso di lavoro e aumentare la produttività.

Prerequisiti

Per usare questo connettore, è necessario un account abilitato per le API da blueink.com.

Come ottenere le credenziali

Dopo aver creato l'account, fare clic sul pulsante API sul lato sinistro della pagina. In Chiavi API private premere il pulsante Aggiungi chiave API . Assegnare al tasto API un'etichetta e premere INVIA. Copiare la chiave API e salvarla in un punto qualsiasi, perché non verrà visualizzata di nuovo.

Introduzione al connettore

Quando si crea per la prima volta una connessione Blueink, verrà richiesto di immettere una chiave API. La chiave API dovrà sempre iniziare con Token seguito da uno spazio e quindi dalla chiave API creata. L'input della chiave API dovrebbe essere simile a questa chiave< API token>.

Un'azione comune consiste nel creare un bundle. La creazione di un bundle richiede un set complesso di input. Esaminare la documentazione dell'API per https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle individuare l'aspetto della variabile del corpo. Immagine seguente come esempio di corpo di creazione del bundle.

Esistono diversi modi per creare un bundle ed è possibile modificare questo codice JSON in base al bundle che si vuole creare. Esaminare l'API per altri modi in cui è possibile modificare questo codice JSON. Questo usa un modello creato in precedenza che l'utente ha configurato nel proprio account.

Elencare tutti i bundle completati è un altro endpoint diffuso. Aggiungere l'azione List Bundles (Aggregazioni elenco) e quindi modificare il pulsante di stato in co per i bundle completati. È possibile mantenere aggiornati tutti i bundle completati più recenti usando questo endpoint.

Problemi noti e limitazioni

Per l'endpoint di creazione del bundle è necessario un codice JSON del corpo

Errori e rimedi comuni

Se viene visualizzato un errore relativo alla mancata riuscita di una richiesta con un errore di token non valido, assicurarsi che non sia stata incollata solo la chiave API in e inclusa la stringa token precedente sia uno spazio e quindi la chiave API.

Se viene visualizzato un errore relativo a un input non valido durante la creazione di un bundle, assicurarsi che sia json valido inviato a Blueink.

Domande frequenti

1. Che cos'è Blueink?

• Blueink è una soluzione di eSignature avanzata che semplifica il processo di firma dei documenti, semplificando l'invio, la firma e la gestione sicura dei documenti elettronici.

2. Che cos'è Il connettore Microsoft per Blueink?

• Il connettore Microsoft per Blueink è uno strumento che consente agli utenti di integrare facilmente la soluzione eSignature di Blueink con Microsoft Power Automate, abilitando l'automazione e la gestione avanzata dei documenti.

3. Come funziona Il connettore Microsoft per Blueink?

• Il connettore consente di creare flussi di lavoro automatizzati combinando Blueink con altri connettori di Power Automate. È possibile automatizzare la creazione e la distribuzione dei bundle di documenti, migliorando i processi di gestione dei documenti.

4. Quali sono alcuni casi d'uso per Il connettore Microsoft per Blueink?

• I casi d'uso comuni includono l'automazione delle approvazioni dei contratti, la gestione di documenti legali, la semplificazione dei processi di lavoro cartacei e la garanzia di un'esperienza di firma dei documenti uniforme ed efficiente per i clienti e gli stakeholder.

5. È possibile usare Il connettore Microsoft per Blueink con altri prodotti Microsoft?

• Sì, il connettore è progettato per funzionare perfettamente con vari prodotti e servizi Microsoft, consentendo di integrare Blueink eSignatures nei flussi di lavoro incentrati su Microsoft.

6. Il connettore Microsoft per Blueink è facile da configurare e usare?

• Sì, è facile da usare e progettato per essere semplice. È possibile configurare e personalizzare i flussi di lavoro in base alle esigenze specifiche di gestione dei documenti.

7. È previsto un costo associato all'uso del connettore Microsoft per Blueink?

• I prezzi possono variare in base all'utilizzo e ai contratti di licenza. È consigliabile consultare Blueink o Microsoft per informazioni specifiche sui prezzi.

8. È possibile ottenere supporto per eventuali problemi tecnici relativi al connettore Microsoft per Blueink?

• Sì, Blueink e Microsoft in genere offrono risorse di supporto e documentazione per facilitare eventuali problemi tecnici o domande sull'utilizzo del connettore.

9. Il connettore Microsoft per Blueink è compatibile con i servizi Microsoft windows e basati sul cloud?

• Sì, il connettore è progettato per funzionare con i servizi Microsoft locali e basati sul cloud, offrendo flessibilità nelle opzioni di integrazione.

10. Dove è possibile trovare altre informazioni sul connettore Microsoft per Blueink?

• Per altre informazioni, incluse le guide alla configurazione e la documentazione, è possibile visitare il sito Web Blueink o esplorare la documentazione di Microsoft Power Automate relativa a questo connettore.

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	Description	Obbligatorio
Chiave API Blueink	securestring	Chiave API Blueink. Questa operazione può essere creata in Blueink nella scheda API. Il formato corretto è 'Token XXXXXX' dove XXXXXX è la chiave API	Vero

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Aggiornare parzialmente un webhook	Aggiornare parzialmente il webhook con nuovi dati.
Aggiornare parzialmente un webhookExtraHeader	Aggiornare parzialmente WebhookExtraHeader con nuovi dati.
Aggiornare parzialmente una persona	Aggiornare parzialmente person con i nuovi dati. Per aggiungere un nuovo messaggio di posta elettronica o telefono alla persona, includere un ContactChannel nella matrice "channels" senza un "id". Per aggiornare un ContactChannel esistente associato alla persona, includere un 'id'. Il contatto esistente verrà aggiornato con il nuovo indirizzo di posta elettronica o telefono. In questo modo verranno aggiornati tutti i bundle live associati alla persona che inviano a tale messaggio di posta elettronica (o telefono). Se un ContactChannel non include un 'id', ma il messaggio di posta elettronica (o telefono) corrisponde a un ContactChannel esistente, tale ContactChannel non verrà modificato.
Aggiornare un pacchetto	Aggiornare un pacchetto (noto anche come firmatario) con un nuovo messaggio di posta elettronica, numero di telefono, nome o opzioni di autenticazione Il pacchetto aggiornato deve comunque essere recapitabile. Ad esempio, se si specifica un deliver_via valore "phone", ma non è stato impostato alcun numero di telefono nell'oggetto PacketRequest originale, la richiesta deve includere anche un phone valore oppure verrà restituito un errore. È possibile modificare un pacchetto configurato originariamente per la firma incorporata( ovvero deliver_via 'incorporamento') da recapitare tramite posta elettronica o SMS. Tuttavia, non verranno inviate automaticamente notifiche di firma o promemoria. È necessario chiamare /packet/{packetId}/remind/ per inviare un messaggio di posta elettronica di notifica di firma (o SMS). Se questo firmatario è associato a una persona, anche la persona verrà aggiornata. Il nome della persona verrà modificato (se specificato) e verrà aggiunto qualsiasi nuovo messaggio di posta elettronica o numero di telefono.
Aggiornare un webhook	Aggiornare il webhook con i nuovi dati. SI NOTI che tutte le sottoscrizioni omesse da questa richiesta verranno ELIMINATE. Se non si vuole sostituire tutti i dati nel webhook, è probabile che si voglia usare PATCH.
Aggiornare un webhookExtraHeader	Aggiornare WebhookExtraHeader con nuovi dati
Aggiornare una persona	Aggiornare la persona con i nuovi dati. SI NOTI che tutti i canali di contatto omessi da questa richiesta verranno ELIMINATI. Se non si vogliono sostituire tutti i dati nella persona, è probabile che si voglia usare PATCH.
Aggiungere tag a un bundle	Aggiungere altri tag a un bundle. Nessun tag esistente nel bundle viene rimosso. Il risultato di questa chiamata è che Bundle.tags è l'unione del set di tag precedenti con il set di nuovi tag. I tag duplicati vengono ignorati.
Annullare un bundle	Annullare il bundle specificato dal bundle slug
Creare un bundle	Creare e inviare un bundle per la firma
Creare un URL di firma incorporato	Creare un URL che può essere usato per la firma incorporata
Creare un webhook	Creare un nuovo webhook
Creare un webhookExtraHeader	Creare una nuova intestazione webhook
Creare una persona	Creare una nuova persona. Una persona può essere associata a un utente BlueInk o può essere una persona autonoma. Se si vuole creare una persona associata a un utente BlueInk, è necessario specificare il user_id campo . Se si vuole creare una persona autonoma, è necessario specificare il name campo .
Elenca webhookExtraHeaders	Elencare tutti i WebhookExtraHeaders nell'account BlueInk
Elencare gli eventi bundle	Ottenere un elenco di eventi associati al bundle
Elencare i bundle	Restituisce un elenco impaginato di bundle nell'account, ordinato in base alla data di creazione (dalla data più recente alla meno recente). La paginazione può essere controllata tramite parametri di paginazione (vedere Panoramica-Paginazione>). I parametri dei filtri di querystring possono essere combinati, ad esempio /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Quando si combinano filtri, vengono restituiti solo i bundle corrispondenti a TUTTI i filtri.
Elencare i modelli di documento	Elencare tutti i modelli di documento
Elencare i webhook	Elencare tutti i webhook nell'account BlueInk
Elencare webhookEvents	Elencare tutti gli eventi webhook nell'account BlueInk
Elencare webhookEvents	Elencare tutti i webhookDeliveries nell'account BlueInk
Elenco Persone	Ottieni un elenco delle persone nel tuo account. Facoltativamente, è possibile filtrare l'elenco fornendo una query di ricerca. Ad esempio, per cercare tutte le persone con il nome "John", usare la query search=John.
Eliminare un webhook	Eliminare un webhook in base all'ID
Eliminare un webhookExtraHeader	Eliminare un webhookExtraHeader
Eliminare una persona	Eliminare una persona. Verrà eliminato anche qualsiasi utente BlueInk associato.
Inviare un promemoria	Inviare un messaggio di posta elettronica di promemoria o UN SMS a un firmatario. Un promemoria può essere inviato una sola volta ogni ora. Il promemoria verrà inviato tramite il metodo di recapito (e-mail o SMS) e all'indirizzo di posta elettronica (o numero di telefono) designato in precedenza per questo pacchetto.
Ottenere il segreto condiviso webhook	Ottenere il segreto condiviso webhook
Recuperare i dati del bundle	Ottenere i dati immessi nei campi per un bundle completato
Recuperare i file di bundle	Ottenere file scaricabili per un bundle completato
Recuperare il certificato di prova dei pacchetti	Ottenere un collegamento e un checksum del certificato di prova per questo pacchetto
Recuperare un bundle	Recuperare un bundle per slug
Recuperare un modello di documento	Recuperare un modello di documento
Recuperare un webhook	Ottenere un webhook in base all'ID
Recuperare un webhookExtraHeader	Recuperare i dettagli di un webhookExtraHeader
Recuperare una persona	Ottenere una persona in base all'ID
Rigenerare il segreto condiviso webhook	Rigenerare il segreto condiviso webhook
Rimuovere tag da un bundle	Rimuovere i tag da un bundle. Se un tag nella richiesta non esiste nel bundle, viene ignorato.

Aggiornare parzialmente un webhook

ID operazione:

updateWebhookartial

Aggiornare parzialmente il webhook con nuovi dati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Webhook ID	webhookId	True	uuid	ID che identifica in modo univoco il webhook
enabled	enabled		boolean
event_types	event_types		array of string	tipi di eventi che attiveranno il webhook
id	id		uuid
nome	name		string	deve aderire a RFC 7230
order	order		integer
value	value		string	deve aderire a RFC 7230
Webhook	webhook		uuid
id	id		uuid
JSON	json		boolean
URL	url		url	deve essere l'URL completo, incluso http/https

Restituisce

Nome	Percorso	Tipo	Descrizione
enabled	enabled	boolean
event_types	event_types	array of string	tipi di eventi che attiveranno il webhook
extra_headers	extra_headers	array of object
id	extra_headers.id	uuid
nome	extra_headers.name	string	deve aderire a RFC 7230
order	extra_headers.order	integer
value	extra_headers.value	string	deve aderire a RFC 7230
Webhook	extra_headers.webhook	uuid
id	id	uuid
JSON	json	boolean
URL	url	url	deve essere l'URL completo, incluso http/https

Aggiornare parzialmente un webhookExtraHeader

ID operazione:

updateWebhookExtraHeaderPartial

Aggiornare parzialmente WebhookExtraHeader con nuovi dati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
WebhookExtraHeader ID	webhookExtraHeaderId	True	uuid	ID che identifica in modo univoco webhookExtraHeader
id	id		uuid
nome	name		string	deve aderire a RFC 7230
order	order		integer
value	value		string	deve aderire a RFC 7230
Webhook	webhook		uuid

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	uuid
nome	name	string	deve aderire a RFC 7230
order	order	integer
value	value	string	deve aderire a RFC 7230
Webhook	webhook	uuid

Aggiornare parzialmente una persona

ID operazione:

updatePersonPartial

Aggiornare parzialmente person con i nuovi dati.

Per aggiungere un nuovo messaggio di posta elettronica o telefono alla persona, includere un ContactChannel nella matrice "channels" senza un "id".

Per aggiornare un ContactChannel esistente associato alla persona, includere un 'id'. Il contatto esistente verrà aggiornato con il nuovo indirizzo di posta elettronica o telefono. In questo modo verranno aggiornati tutti i bundle live associati alla persona che inviano a tale messaggio di posta elettronica (o telefono).

Se un ContactChannel non include un 'id', ma il messaggio di posta elettronica (o telefono) corrisponde a un ContactChannel esistente, tale ContactChannel non verrà modificato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID persona	personId	True	uuid	ID che identifica in modo univoco la persona
posta elettronica	email		email
id	id		uuid
tipo/gentile	kind		string	em per la posta elettronica. mp per telefono.
phone	phone		phone
id	id		uuid
is_user	is_user		boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata		object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name		string	Nome della persona

Restituisce

Nome	Percorso	Tipo	Descrizione
channels	channels	array of object
posta elettronica	channels.email	email
id	channels.id	uuid
tipo/gentile	channels.kind	string	em per la posta elettronica. mp per telefono.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata	object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name	string	Nome della persona

Aggiornare un pacchetto

ID operazione:

updatePacket

Aggiornare un pacchetto (noto anche come firmatario) con un nuovo messaggio di posta elettronica, numero di telefono, nome o opzioni di autenticazione

Il pacchetto aggiornato deve comunque essere recapitabile. Ad esempio, se si specifica un deliver_via valore "phone", ma non è stato impostato alcun numero di telefono nell'oggetto PacketRequest originale, la richiesta deve includere anche un phone valore oppure verrà restituito un errore.

È possibile modificare un pacchetto configurato originariamente per la firma incorporata( ovvero deliver_via 'incorporamento') da recapitare tramite posta elettronica o SMS. Tuttavia, non verranno inviate automaticamente notifiche di firma o promemoria. È necessario chiamare /packet/{packetId}/remind/ per inviare un messaggio di posta elettronica di notifica di firma (o SMS).

Se questo firmatario è associato a una persona, anche la persona verrà aggiornata. Il nome della persona verrà modificato (se specificato) e verrà aggiunto qualsiasi nuovo messaggio di posta elettronica o numero di telefono.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Slug pacchetto	packetId	True	string	Lo slug che identifica in modo univoco il pacchetto
body	body

Aggiornare un webhook

ID operazione:

updateWebhook

Aggiornare il webhook con i nuovi dati. SI NOTI che tutte le sottoscrizioni omesse da questa richiesta verranno ELIMINATE. Se non si vuole sostituire tutti i dati nel webhook, è probabile che si voglia usare PATCH.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Webhook ID	webhookId	True	uuid	ID che identifica in modo univoco il webhook
enabled	enabled		boolean
event_types	event_types		array of string	tipi di eventi che attiveranno il webhook
id	id		uuid
nome	name		string	deve aderire a RFC 7230
order	order		integer
value	value		string	deve aderire a RFC 7230
Webhook	webhook		uuid
id	id		uuid
JSON	json		boolean
URL	url		url	deve essere l'URL completo, incluso http/https

Restituisce

Nome	Percorso	Tipo	Descrizione
enabled	enabled	boolean
event_types	event_types	array of string	tipi di eventi che attiveranno il webhook
extra_headers	extra_headers	array of object
id	extra_headers.id	uuid
nome	extra_headers.name	string	deve aderire a RFC 7230
order	extra_headers.order	integer
value	extra_headers.value	string	deve aderire a RFC 7230
Webhook	extra_headers.webhook	uuid
id	id	uuid
JSON	json	boolean
URL	url	url	deve essere l'URL completo, incluso http/https

Aggiornare un webhookExtraHeader

ID operazione:

updateWebhookExtraHeader

Aggiornare WebhookExtraHeader con nuovi dati

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
WebhookExtraHeader ID	webhookExtraHeaderId	True	uuid	ID che identifica in modo univoco webhookExtraHeader
id	id		uuid
nome	name		string	deve aderire a RFC 7230
order	order		integer
value	value		string	deve aderire a RFC 7230
Webhook	webhook		uuid

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	uuid
nome	name	string	deve aderire a RFC 7230
order	order	integer
value	value	string	deve aderire a RFC 7230
Webhook	webhook	uuid

Aggiornare una persona

ID operazione:

updatePerson

Aggiornare la persona con i nuovi dati. SI NOTI che tutti i canali di contatto omessi da questa richiesta verranno ELIMINATI. Se non si vogliono sostituire tutti i dati nella persona, è probabile che si voglia usare PATCH.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID persona	personId	True	uuid	ID che identifica in modo univoco la persona
posta elettronica	email		email
id	id		uuid
tipo/gentile	kind		string	em per la posta elettronica. mp per telefono.
phone	phone		phone
id	id		uuid
is_user	is_user		boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata		object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name		string	Nome della persona

Restituisce

Nome	Percorso	Tipo	Descrizione
channels	channels	array of object
posta elettronica	channels.email	email
id	channels.id	uuid
tipo/gentile	channels.kind	string	em per la posta elettronica. mp per telefono.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata	object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name	string	Nome della persona

Aggiungere tag a un bundle

ID operazione:

addBundleTags

Aggiungere altri tag a un bundle. Nessun tag esistente nel bundle viene rimosso. Il risultato di questa chiamata è che Bundle.tags è l'unione del set di tag precedenti con il set di nuovi tag. I tag duplicati vengono ignorati.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Bundle Slug	bundleSlug	True	string	Lo slug che identifica in modo univoco il bundle
tags	tags		array of string	Matrice di tag

Annullare un bundle

ID operazione:

cancelBundle

Annullare il bundle specificato dal bundle slug

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Bundle Slug	bundleSlug	True	string	Lo slug che identifica in modo univoco il bundle

Creare un bundle

ID operazione:

createBundle

Creare e inviare un bundle per la firma

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
body	body			Corpo JSON che definisce il bundle da creare

Creare un URL di firma incorporato

ID operazione:

createPacketEmbedURL

Creare un URL che può essere usato per la firma incorporata

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Slug pacchetto	packetId	True	string	Lo slug che identifica in modo univoco il pacchetto

Restituisce

Nome	Percorso	Tipo	Descrizione
Scade	expires	date-time	Timestamp che indica la scadenza dell'URL
URL	url	string	URL che può essere usato in per la firma incorporata

Creare un webhook

ID operazione:

createWebhook

Creare un nuovo webhook

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
enabled	enabled		boolean
event_types	event_types		array of string	tipi di eventi che attiveranno il webhook
id	id		uuid
nome	name		string	deve aderire a RFC 7230
order	order		integer
value	value		string	deve aderire a RFC 7230
Webhook	webhook		uuid
id	id		uuid
JSON	json		boolean
URL	url		url	deve essere l'URL completo, incluso http/https

Restituisce

Nome	Percorso	Tipo	Descrizione
enabled	enabled	boolean
event_types	event_types	array of string	tipi di eventi che attiveranno il webhook
extra_headers	extra_headers	array of object
id	extra_headers.id	uuid
nome	extra_headers.name	string	deve aderire a RFC 7230
order	extra_headers.order	integer
value	extra_headers.value	string	deve aderire a RFC 7230
Webhook	extra_headers.webhook	uuid
id	id	uuid
JSON	json	boolean
URL	url	url	deve essere l'URL completo, incluso http/https

Creare un webhookExtraHeader

ID operazione:

createWebhookExtraHeader

Creare una nuova intestazione webhook

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
id	id		uuid
nome	name		string	deve aderire a RFC 7230
order	order		integer
value	value		string	deve aderire a RFC 7230
Webhook	webhook		uuid

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	uuid
nome	name	string	deve aderire a RFC 7230
order	order	integer
value	value	string	deve aderire a RFC 7230
Webhook	webhook	uuid

Creare una persona

ID operazione:

createPerson

Creare una nuova persona. Una persona può essere associata a un utente BlueInk o può essere una persona autonoma. Se si vuole creare una persona associata a un utente BlueInk, è necessario specificare il user_id campo . Se si vuole creare una persona autonoma, è necessario specificare il name campo .

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
posta elettronica	email		email
id	id		uuid
tipo/gentile	kind		string	em per la posta elettronica. mp per telefono.
phone	phone		phone
id	id		uuid
is_user	is_user		boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata		object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name		string	Nome della persona

Restituisce

Nome	Percorso	Tipo	Descrizione
channels	channels	array of object
posta elettronica	channels.email	email
id	channels.id	uuid
tipo/gentile	channels.kind	string	em per la posta elettronica. mp per telefono.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata	object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name	string	Nome della persona

Elenca webhookExtraHeaders

ID operazione:

listWebhookExtraHeaders

Elencare tutti i WebhookExtraHeaders nell'account BlueInk

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Webhook ID	webhook		uuid	Verranno restituiti solo WebhookExtraHeaders corrispondenti all'ID webhook selezionato. ad esempio /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346.
Tipo di evento	event_type		string	Verranno restituiti solo webhookExtraHeaders con webhook corrispondenti al event_type selezionato o event_types. Ad esempio, /webhooks/headers/?event_type=bundle_sent ad esempio /webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
id	id	uuid
nome	name	string	deve aderire a RFC 7230
order	order	integer
value	value	string	deve aderire a RFC 7230
Webhook	webhook	uuid

Elencare gli eventi bundle

ID operazione:

listBundleEvents

Ottenere un elenco di eventi associati al bundle

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Bundle Slug	bundleSlug	True	string	Lo slug che identifica in modo univoco il bundle

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
descrizione	description	string	Breve rimozione dell'evento
tipo/gentile	kind	string	Tipo di evento come codice di 2 caratteri
packet_id	packet_id	uuid	UUID di un pacchetto. Presente solo se l'evento è associato a un pacchetto specifico.
Marca temporale	timestamp	date-time	Ora in cui si è verificato l'evento

Elencare i bundle

ID operazione:

listBundles

Restituisce un elenco impaginato di bundle nell'account, ordinato in base alla data di creazione (dalla data più recente alla meno recente). La paginazione può essere controllata tramite parametri di paginazione (vedere Panoramica-Paginazione>). I parametri dei filtri di querystring possono essere combinati, ad esempio /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Quando si combinano filtri, vengono restituiti solo i bundle corrispondenti a TUTTI i filtri.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Query di ricerca	search		string	Query di ricerca. Verranno restituiti solo bundle corrispondenti alla ricerca. Vengono cercati i dati seguenti nel bundle: bundle slug etichetta bundle bundle custom_key nome del firmatario messaggio di posta elettronica del firmatario telefoni firmatari ad esempio /bundles/?search=foobar@example.com.
Stato bundle	status		string	Limitare i bundle a quelli con lo stato specificato. dr: Bozza - Il bundle non è ancora stato inviato se: Inviato - Il bundle è stato inviato, ma non ancora avviato da alcun firmatario st: Avviato: almeno un firmatario ha iniziato a esaminare i documenti co: Completato : tutti i firmatari hanno completato la revisione/firma ca: Annullato - Il bundle è stato annullato ad esempio: Scaduto - Il bundle è scaduto prima del completamento fa: Failed - Si è verificato un errore e non è stato possibile creare o completare il bundle ad esempio /bundles/?status=co.
Elenco dello stato del bundle	status__in		string	Limitare i bundle a quelli con uno degli stati specificati. Gli stati devono essere separati da virgole. ad esempio /bundles/?status=co,se,st.
Bundle Tag	tag		string	Restituisce bundle con il tag specificato. ad esempio /bundles/?tag=some-tag.
Elenco di tag bundle	tag__in		string	Restituisce bundle con almeno uno dei tag specificati. I tag devono essere delimitati da virgole. ad esempio /bundles/?tag=some-tag,another-tag.
Ordinamento bundle	ordering		string	Controllare l'ordinamento dei bundle. Prefisso con "-" per invertire l'ordinamento. Per impostazione predefinita, i bundle vengono ordinati in base a "-created", ovvero la data di creazione del bundle dalla più recente alla meno recente.

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of

Elencare i modelli di documento

ID operazione:

listTemplates

Elencare tutti i modelli di documento

Restituisce

Nome	Percorso	Tipo	Descrizione
fields	fields	array of	Matrice di campi inseriti nel documento. Si noti che i campi DocumentTemplate sono leggermente diversi dai campi DocumentRequest, con e default_valueeditor_roles invece di initial_value e editors.
file_url	file_url	string	URL del file originale che funge da base per questo modello
is_shared	is_shared	boolean	True se il modello di documento è condiviso. Falso in caso contrario
nome	name	string	Nome del documento. L'impostazione predefinita è il nome file o il documento quando è stato caricato, ma può essere impostato su un nome descrittivo.
roles	roles	array of object
key	roles.key	string	Stringa univoca per questo documento che identifica questo ruolo
label	roles.label	string	Un'etichetta descrittiva per questo ruolo

Elencare i webhook

ID operazione:

listWebhooks

Elencare tutti i webhook nell'account BlueInk

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Enabled	enabled		boolean	Verranno restituiti solo i webhook corrispondenti allo stato "abilitato" selezionato. ad esempio /webhooks/?enabled=true.
Tipo di evento	event_type		string	Verranno restituiti solo i webhook corrispondenti al event_type selezionato o event_types. Ad esempio, /webhooks/?event_type=bundle_sent ad esempio /webhooks/?event_type__in=bundle_error,bundle_cancelled

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
enabled	enabled	boolean
event_types	event_types	array of string	tipi di eventi che attiveranno il webhook
extra_headers	extra_headers	array of object
id	extra_headers.id	uuid
nome	extra_headers.name	string	deve aderire a RFC 7230
order	extra_headers.order	integer
value	extra_headers.value	string	deve aderire a RFC 7230
Webhook	extra_headers.webhook	uuid
id	id	uuid
JSON	json	boolean
URL	url	url	deve essere l'URL completo, incluso http/https

Elencare webhookEvents

ID operazione:

listWebhookEvents

Elencare tutti gli eventi webhook nell'account BlueInk

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Webhook ID	webhook		uuid	Verranno restituiti solo webhookEvent corrispondenti all'ID webhook selezionato. ad esempio /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346.
Tipo di evento	event_type		string	Verranno restituiti solo webhookEvent con webhook corrispondenti al event_type selezionato o event_types. Ad esempio, /webhooks/events/?event_type=bundle_sent ad esempio /webhooks/events/?event_type__in=bundle_error,bundle_cancelled
stato	status		integer	Verranno restituiti solo webhookEvent corrispondenti allo stato selezionato. Ad esempio, /webhooks/events/?status=1 ad esempio /webhooks/events/?status__in=0,1,2
Risultato esito positivo	success		boolean	Verranno restituiti solo webhookEvent corrispondenti allo stato di esito positivo selezionato. ad esempio /webhooks/events/?success=true.
Intervallo di date	date		date-time	Verranno restituiti solo gli eventi WebhookEvent che si verificano tra un intervallo di date. Nota: le date sono espresse come formato AAAA-MM-DD. ad esempio /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31.

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
creato	created	date-time
Consegne	deliveries	array of object
message	deliveries.message	string	un messaggio che descrive eventuali problemi
Pk	deliveries.pk	uuid
status	deliveries.status	integer	messaggio di stato della risposta o 0 se non è presente alcuno stato
Marca temporale	deliveries.timestamp	date-time	quando si è verificato il tentativo di recapito (l'inizio del tentativo, non quando non è riuscito, ad esempio per un timeout)
event_type	event_type	string
payload	payload	string	payload da inviare al recapito; json
Pk	pk	uuid
status	status	integer	codice di stato dell'ultima risposta dall'endpoint del webhook. 0 indica che non è stata ricevuta alcuna risposta
successo	success	boolean
Webhook	webhook	uuid	UUID che identifica il webhook a cui appartiene l'evento

Elencare webhookEvents

ID operazione:

listWebhookDeliveries

Elencare tutti i webhookDeliveries nell'account BlueInk

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Webhook ID	webhook		uuid	Verranno restituiti solo webhookDeliveries corrispondenti all'ID webhook selezionato. ad esempio /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346.
ID evento webhook	webhook_event		uuid	Verranno restituiti solo webhookDeliveries corrispondenti all'ID webhook_event selezionato. ad esempio /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346.
Tipo di evento	event_type		string	Verranno restituiti solo webhookDeliveries con webhook corrispondenti al event_type selezionato o event_types. Ad esempio, /webhooks/deliveries/?event_type=bundle_sent ad esempio /webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
stato	status		integer	Verranno restituiti solo webhookDeliveries corrispondenti allo stato selezionato. Ad esempio, /webhooks/deliveries/?status=1 ad esempio /webhooks/deliveries/?status__in=0,1,2
Intervallo di date	date		date-time	Verranno restituiti solo i webhookDeliveries che si verificano tra un intervallo di date. Nota: le date sono espresse come formato AAAA-MM-DD. ad esempio /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31.

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
creato	created	date-time
Consegne	deliveries	array of object
message	deliveries.message	string	un messaggio che descrive eventuali problemi
Pk	deliveries.pk	uuid
status	deliveries.status	integer	messaggio di stato della risposta o 0 se non è presente alcuno stato
Marca temporale	deliveries.timestamp	date-time	quando si è verificato il tentativo di recapito (l'inizio del tentativo, non quando non è riuscito, ad esempio per un timeout)
event_type	event_type	string
payload	payload	string	payload da inviare al recapito; json
Pk	pk	uuid
status	status	integer	codice di stato dell'ultima risposta dall'endpoint del webhook. 0 indica che non è stata ricevuta alcuna risposta
successo	success	boolean
Webhook	webhook	uuid	UUID che identifica il webhook a cui appartiene l'evento

Elenco Persone

ID operazione:

listPersons

Ottieni un elenco delle persone nel tuo account. Facoltativamente, è possibile filtrare l'elenco fornendo una query di ricerca. Ad esempio, per cercare tutte le persone con il nome "John", usare la query search=John.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Query di ricerca	search		string	Query di ricerca.

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
channels	channels	array of object
posta elettronica	channels.email	email
id	channels.id	uuid
tipo/gentile	channels.kind	string	em per la posta elettronica. mp per telefono.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata	object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name	string	Nome della persona

Eliminare un webhook

ID operazione:

deleteWebhook

Eliminare un webhook in base all'ID

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Webhook ID	webhookId	True	uuid	ID che identifica in modo univoco il webhook

Eliminare un webhookExtraHeader

ID operazione:

deleteWebhookExtraHeader

Eliminare un webhookExtraHeader

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
WebhookExtraHeader ID	webhookExtraHeaderId	True	uuid	ID che identifica in modo univoco webhookExtraHeader

Eliminare una persona

ID operazione:

deletePerson

Eliminare una persona. Verrà eliminato anche qualsiasi utente BlueInk associato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID persona	personId	True	uuid	ID che identifica in modo univoco la persona

Inviare un promemoria

ID operazione:

sendPacketReminder

Inviare un messaggio di posta elettronica di promemoria o UN SMS a un firmatario. Un promemoria può essere inviato una sola volta ogni ora. Il promemoria verrà inviato tramite il metodo di recapito (e-mail o SMS) e all'indirizzo di posta elettronica (o numero di telefono) designato in precedenza per questo pacchetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Slug pacchetto	packetId	True	string	Lo slug che identifica in modo univoco il pacchetto

Ottenere il segreto condiviso webhook

ID operazione:

getWebhookSecret

Ottenere il segreto condiviso webhook

Restituisce

Nome	Percorso	Tipo	Descrizione
create_date	create_date	date-time
secret	secret	b58

Recuperare i dati del bundle

ID operazione:

getBundleData

Ottenere i dati immessi nei campi per un bundle completato

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Bundle Slug	bundleSlug	True	string	Lo slug che identifica in modo univoco il bundle

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
attachments	attachments	array of object	Matrice di allegati di file per un campo allegato o Null
Ext	attachments.ext	string	Estensione del file
is_image	attachments.is_image	boolean	true se il file allegato è un'immagine
nome	attachments.name	string	Nome file dell'allegato
Num	attachments.num	integer	L'ordine in cui è stato aggiunto il file, se sono presenti più caricamenti per un singolo campo allegato (ad esempio, una foto per ogni pagina di un documento acquisito con una webcam)
size	attachments.size	integer	Dimensioni del file, in byte
URL	attachments.url	url	URL che può essere usato temporaneamente per scaricare il file allegato
doc_key	doc_key	string	Chiave che identifica in modo univoco il documento nel bundle (dall'oggetto BundleRequest originale)
field_key	field_key	string	Chiave che identifica in modo univoco il campo nel documento (come specificato nell'oggetto DocumentRequestField originale in BundleRequest o come configurato in DocumentTemplate)
filled_by	filled_by	string	Chiave pacchetto del firmatario che ha immesso il valore per questo campo. Se il valore del campo è un 'initial_value' non modificato da un firmatario, il valore è 'initial'. Se il valore del campo è il valore predefinito configurato in un Oggetto DocumentTemplate, il filler è 'default'.
tipo/gentile	kind	string	Tipo di campo
label	label	string	Etichetta del campo (possibilmente vuota)
packet_id	packet_id		ID pacchetto del firmatario che ha immesso il valore per questo campo oppure null se il valore del campo non è stato compilato da un firmatario (ad esempio, è un valore initial_value o defaul).
value	value		Valore del campo .

Recuperare i file di bundle

ID operazione:

getBundleFiles

Ottenere file scaricabili per un bundle completato

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Bundle Slug	bundleSlug	True	string	Lo slug che identifica in modo univoco il bundle

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
Scade	expires	string	Ora in cui scade il collegamento, come ora formattata ISO 8601
file_url	file_url	string	URL da cui è possibile scaricare il file

Recuperare il certificato di prova dei pacchetti

ID operazione:

getPacketCOE

Ottenere un collegamento e un checksum del certificato di prova per questo pacchetto

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Slug pacchetto	packetId	True	string	Lo slug che identifica in modo univoco il pacchetto

Recuperare un bundle

ID operazione:

retrieveBundle

Recuperare un bundle per slug

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Bundle Slug	bundleSlug	True	string	Lo slug che identifica in modo univoco il bundle

Recuperare un modello di documento

ID operazione:

retrieveTemplate

Recuperare un modello di documento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID modello	templateId	True	uuid	ID che identifica in modo univoco il modello

Restituisce

Nome	Percorso	Tipo	Descrizione
fields	fields	array of	Matrice di campi inseriti nel documento. Si noti che i campi DocumentTemplate sono leggermente diversi dai campi DocumentRequest, con e default_valueeditor_roles invece di initial_value e editors.
file_url	file_url	string	URL del file originale che funge da base per questo modello
is_shared	is_shared	boolean	True se il modello di documento è condiviso. Falso in caso contrario
nome	name	string	Nome del documento. L'impostazione predefinita è il nome file o il documento quando è stato caricato, ma può essere impostato su un nome descrittivo.
roles	roles	array of object
key	roles.key	string	Stringa univoca per questo documento che identifica questo ruolo
label	roles.label	string	Un'etichetta descrittiva per questo ruolo

Recuperare un webhook

ID operazione:

getWebhook

Ottenere un webhook in base all'ID

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Webhook ID	webhookId	True	uuid	ID che identifica in modo univoco il webhook

Restituisce

Nome	Percorso	Tipo	Descrizione
enabled	enabled	boolean
event_types	event_types	array of string	tipi di eventi che attiveranno il webhook
extra_headers	extra_headers	array of object
id	extra_headers.id	uuid
nome	extra_headers.name	string	deve aderire a RFC 7230
order	extra_headers.order	integer
value	extra_headers.value	string	deve aderire a RFC 7230
Webhook	extra_headers.webhook	uuid
id	id	uuid
JSON	json	boolean
URL	url	url	deve essere l'URL completo, incluso http/https

Recuperare un webhookExtraHeader

ID operazione:

getWebhookExtraHeader

Recuperare i dettagli di un webhookExtraHeader

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
WebhookExtraHeader ID	webhookExtraHeaderId	True	uuid	ID che identifica in modo univoco webhookExtraHeader

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	uuid
nome	name	string	deve aderire a RFC 7230
order	order	integer
value	value	string	deve aderire a RFC 7230
Webhook	webhook	uuid

Recuperare una persona

ID operazione:

getPerson

Ottenere una persona in base all'ID

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID persona	personId	True	uuid	ID che identifica in modo univoco la persona

Restituisce

Nome	Percorso	Tipo	Descrizione
channels	channels	array of object
posta elettronica	channels.email	email
id	channels.id	uuid
tipo/gentile	channels.kind	string	em per la posta elettronica. mp per telefono.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se questa persona è associata a un utente BlueInk
metadata	metadata	object	Metadati da associare a questa persona. I metadati possono essere usati in SmartFill per popolare automaticamente i documenti. Per informazioni dettagliate, vedere la documentazione di SmartFill.
nome	name	string	Nome della persona

Rigenerare il segreto condiviso webhook

ID operazione:

regenerateWebhookSecret

Rigenerare il segreto condiviso webhook

Restituisce

Nome	Percorso	Tipo	Descrizione
create_date	create_date	date-time
secret	secret	b58

Rimuovere tag da un bundle

ID operazione:

removeBundleTags

Rimuovere i tag da un bundle. Se un tag nella richiesta non esiste nel bundle, viene ignorato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Bundle Slug	bundleSlug	True	string	Lo slug che identifica in modo univoco il bundle
tags	tags		array of string	Matrice di tag