Segno di contrassegno (anteprima)
Mark Sign è un servizio di firma elettronica qualificato conforme alle normative eIDAS. Inviare documenti per la firma, attendere le firme, scaricare e convalidare i file firmati.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Service | Classe | Regions |
|---|---|---|
| Copilot Studio | Premium | Tutte le aree 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 Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Premium | Tutte le aree Power Apps 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) |
| Power Automate | Premium | Tutte le aree 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 | |
|---|---|
| Name | ID contrassegno, UAB |
| URL | https://marksign.eu |
| pagalba@marksign.lt |
| Metadati del connettore | |
|---|---|
| Editore | ID contrassegno, UAB |
| Website | https://marksign.eu |
| Informativa sulla privacy | https://marksign.eu/privacy-policy |
| Categorie | Produttività; Contenuto e file |
Segna segno
Mark Sign è un servizio di firma elettronica qualificato conforme alla normativa eIDAS. Un flusso può inviare un documento per la firma, attendere che venga firmato, quindi scaricare il file firmato e convalidarlo.
Publisher: ID contrassegno, UAB
Prerequisites
È necessario un token di accesso dell'API Mark Sign. Vedere Ottenere le credenziali di seguito.
Operazioni supportate
Documento: Carica
Carica un documento (PDF, ADoc, BDoc o ASiC-E) e lo prepara per la firma. Il nome del file diventa il titolo del documento.
Firma: invita tramite posta elettronica
Invita una persona a firmare; Mark Sign invia il messaggio di posta elettronica di invito. Chiamare di nuovo per la stessa persona invia un promemoria.
Firma: Invitare per URL
Aggiunge un firmatario senza inviare un messaggio di posta elettronica e restituisce il relativo URL di invito personale da recapitare.
Firma: attendere tutti i firmatari
Mantiene il flusso fino a quando il documento non viene firmato o rifiutato o termina con lo stato in cui si esaurisce il timed_out tempo di attesa (29 giorni per impostazione predefinita).
Firma: attendere un firmatario
Mantiene il flusso fino a un particolare firmatario, scelto dal messaggio di posta elettronica, firma. Qualsiasi rifiuto termina anche l'attesa.
Firma: attendere il firmatario successivo
Riprende il flusso nel momento in cui il firmatario successivo firma o rifiuta, senza polling.
Documento: Ottenere lo stato
Controlla lo stato complessivo della firma del documento.
Documento: Ottenere i firmatari
Elenca lo stato di ogni firmatario, incluso il motivo di rifiuto se un firmatario ha rifiutato.
Documento: Download
Scarica il documento con tutte le firme raccolte finora.
Documento: Elenco
Elenca i documenti nell'area di lavoro, con ricerca di testo e paging.
Documento: Rimuovi
Rimuove un documento dall'area di lavoro.
Documento: Caricare come contenitore
Combina diversi file in un unico documento contenitore firmabile (ADoc, BDoc o ASiC-E). La fatturazione segue l'impostazione predefinita Mark Sign, in cui ogni firmatario paga.
Firma: creare collegamenti del firmatario
Crea un collegamento di firma personale per ogni firmatario, per recapitarti manualmente. I collegamenti scadono, possono richiedere la verifica dell'identità e sono le uniche pagine di firma con un'opzione di rifiuto.
Firma: Creare un collegamento condiviso
Crea un collegamento che chiunque può aprire per firmare i documenti, ognuno con la propria identità verificata.
Firma: elimina collegamento
Elimina un collegamento di firmatario o un collegamento condiviso prima della scadenza.
Documento: Estendere la validità della firma
Aggiorna le firme dei documenti per la validità a lungo termine (LT) o l'archiviazione a lungo termine (LTA).
Documento: Convalida
Controlla le firme di un documento e restituisce il report di convalida completo.
Recupero delle credenziali
Per richiedere un token di accesso API per l'area di lavoro, contattare il supporto pagalba@marksign.lt clienti di Mark Sign. Quando si crea una connessione in Power Automate, incollare il token nel campo "Chiave API".
Il token è associato a un'area di lavoro, quindi ogni documento creato o elencato tramite la connessione appartiene a tale area di lavoro.
Getting Started
Il flusso di firma più semplice:
- Documento: caricare (ad esempio, il contenuto del file e i token dei nomi da SharePoint o OneDrive).
- Firma: invita tramite posta elettronica. Contrassegna Firma invia un messaggio di posta elettronica all'invito.
- Firma: attendere il firmatario successivo. Il flusso viene sospeso qui fino a quando non si verifica la firma.
- Documento: scaricare e archiviarlo dove è necessario.
Con diversi firmatari, usare Firma: Invita tramite posta elettronica per ogni persona, quindi una firma: attendere il passaggio di tutti i firmatari prima del download. Per recapitare manualmente i collegamenti invece di Contrassegnare i messaggi di posta elettronica, usare Firma: Invita per URL o Firma: Creare collegamenti firmatari e inviare a ogni persona il collegamento con l'azione di Outlook o Teams personalizzata.
Problemi noti e limitazioni
- Il connettore non fornisce trigger di flusso; usare invece le operazioni di attesa all'interno di un flusso.
- Un documento ha una registrazione di notifica. Non eseguire due operazioni di firma: attendere i passaggi successivi del firmatario nello stesso documento contemporaneamente. Il secondo sostituisce il primo e il primo passaggio quindi attende fino al timeout. La compilazione di un campo URL di callback in qualsiasi blocco sostituisce anche la registrazione.
- I firmatari possono rifiutare un documento solo in una pagina Firma: Crea collegamenti firmatari (con Mostra pulsante rifiuta su); gli inviti tramite posta elettronica, gli URL di invito e i collegamenti condivisi non offrono alcuna opzione di rifiuto.
- Mark Sign notifica solo le firme. Quando un blocco di invito usa uno scopo di
reviewoconfirmation, l'azione di tale persona non viene mai riattivata firma: attendere il firmatario successivo; controllare lo stato con Document: Get signers . - Documento: il download restituisce solo il contenuto del file; prendere il nome del file da Document: List o dal passaggio di caricamento.
- Un'esecuzione del flusso può durare al massimo 30 giorni (un limite di Power Automate), in modo che nessuna attesa possa durare.
Firma: attendere tutti i firmatari e la firma: attendere che un firmatario termina con lo
timed_outstato dopo 29 giorni per impostazione predefinita. Per firma: attendere il firmatario successivo, impostare un timeout (ad esempioP29D) nelle impostazioni dell'azione e aggiungere un ramo configurato per l'esecuzione dopo il timeout dell'azione. Se il limite di esecuzione di 30 giorni raggiunge per primo, Power Automate annulla l'intera esecuzione e nessun ramo lo gestisce. - Documento: l'elenco non supporta il filtro in base allo stato.
- Documento: il caricamento accetta un file per ogni chiamata; eseguire un ciclo sugli allegati per caricare diversi. Documento: il caricamento come contenitore è destinato ad alcuni file; la combinazione di molti file di grandi dimensioni in una chiamata può superare il limite di tempo di elaborazione.
Istruzioni per la distribuzione
Eseguire paconn create --api-prop apiProperties.json --api-def apiDefinition.swagger.json --script script.csx --icon icon.png per distribuire questo connettore come connettore personalizzato nell'ambiente Power Platform. Per informazioni dettagliate, vedere la documentazione paconn .
Support
Per problemi relativi al connettore o all'API Mark Sign, contattare pagalba@marksign.lt.
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.
| Name | Type | Description | Required |
|---|---|---|---|
| Chiave API | securestring | Token di accesso dell'API Mark Sign dell'area di lavoro. Richiedere uno dal supporto di Mark Sign all'indirizzo pagalba@marksign.lt. | True |
Azioni
| Documento: Carica |
Carica un documento e lo prepara per la firma. |
| Documento: Caricare come contenitore |
Combina diversi file in un unico documento contenitore firmabile, ad esempio ADoc o ASiC-E. I file vengono caricati e combinati in un unico passaggio. |
| Documento: Convalida |
Controlla le firme di un documento e restituisce il report di convalida. Il flusso attende fino al termine del controllo. |
| Documento: Download |
Scarica il documento con tutte le firme raccolte finora. |
| Documento: Elenco |
Elenca i documenti nell'area di lavoro, più recente. |
| Documento: Estendere la validità della firma |
Aggiorna le firme del documento per la validità o l'archiviazione a lungo termine. |
| Documento: Ottenere i firmatari |
Elenca i firmatari di un documento con il relativo stato di firma. |
| Documento: Ottenere lo stato |
Ottiene lo stato di firma di un documento. |
| Documento: Rimuovi |
Rimuove un documento dall'area di lavoro. |
| Firma: attendere il firmatario successivo |
Attende fino a quando il firmatario successivo firma o rifiuta il documento, senza inviare alcun invito. Usarlo in un ciclo per attendere diversi firmatari senza eseguire il polling. |
| Firma: attendere tutti i firmatari |
Attende fino a quando ogni firmatario ha firmato o ha rifiutato il documento, quindi consente al flusso di continuare. Termina con lo stato timed_out quando si verifica il timeout. |
| Firma: attendere un firmatario |
Attende fino a quando un particolare firmatario firma il documento, quindi consente al flusso di continuare. Termina con lo stato timed_out quando si verifica il timeout. |
| Firma: creare collegamenti del firmatario |
Crea un collegamento di firma personale per ogni firmatario. I collegamenti vengono recapitati manualmente, ad esempio tramite posta elettronica o messaggio di Teams. |
| Firma: Creare un collegamento condiviso |
Crea un collegamento di firma che chiunque può aprire per firmare i documenti. Lo dia a te stesso. |
| Firma: elimina collegamento |
Elimina un collegamento di firmatario o un collegamento condiviso prima della scadenza. Impossibile eliminare i collegamenti di invito. |
| Firma: invita tramite posta elettronica |
Invita una persona a firmare il documento. Mark Sign invia l'invito tramite posta elettronica. |
| Firma: Invitare per URL |
Aggiunge un firmatario al documento senza inviare un messaggio di posta elettronica e restituisce il relativo collegamento di invito personale da recapitare. Il collegamento non scade e non può essere eliminato; usare "Firma: Creare collegamenti firmatari" quando sono necessari collegamenti che è possibile revocare. |
Documento: Carica
Carica un documento e lo prepara per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome del file
|
file_name | True | string |
Nome del file con la relativa estensione, ad esempio contract.pdf. Diventa il titolo del documento. |
|
body
|
body | True | binary | |
|
Access
|
access | string |
Chi può visualizzare il documento. Il valore predefinito è privato. |
|
|
Tipo di fatturazione
|
billing_type | True | string |
Chi paga le firme. |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
ID documento
|
data.uuid | string |
ID del documento. |
|
Nome del file
|
data.filename | string |
Nome del file. |
Documento: Caricare come contenitore
Combina diversi file in un unico documento contenitore firmabile, ad esempio ADoc o ASiC-E. I file vengono caricati e combinati in un unico passaggio.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Tipo di documento
|
document_type | True | string |
Tipo di documento da creare. |
|
Nome del file
|
file_name | True | string |
Nome del file con la relativa estensione, ad esempio contract.pdf. |
|
Contenuto del file
|
file_content | True | byte |
Contenuto del file. |
|
Tipo di file (solo ADoc)
|
adoc_file_type | string |
Ruolo del file nel contenitore. Utilizzato solo quando il tipo di documento è un ADoc. |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
ID documento
|
data.uuid | string |
ID del documento. |
|
Nome del file
|
data.filename | string |
Nome del file di documento. |
Documento: Convalida
Controlla le firme di un documento e restituisce il report di convalida. Il flusso attende fino al termine del controllo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
Valido
|
data.document.is_valid | boolean |
Indica se le firme del documento sono valide. |
|
Data di fine validità
|
data.document.valid_to | string |
Per quanto tempo il documento rimane valido. |
|
Nome documento
|
data.document.name | string |
Titolo del documento. |
|
Tipo MIME
|
data.document.mimetype | string |
Tipo di file del documento. |
|
Firme:
|
data.signatures | array of object |
Risultato per ogni firma. |
|
ID firma
|
data.signatures.id | string |
ID della firma. |
|
Ora di firma
|
data.signatures.signing_time | string |
Quando è stata effettuata la firma. |
|
Formato firma
|
data.signatures.signature_format | string |
Formato della firma. |
|
Valido
|
data.signatures.is_valid | boolean |
Indica se la firma è valida. |
|
Data di fine validità
|
data.signatures.valid_to | string |
Durata della validità della firma. |
|
Attestati
|
data.certificates | array of object |
Certificati usati dalle firme. |
|
items
|
data.certificates | object | |
|
Timestamp
|
data.timestamps | array of object |
Timestamp applicati al documento. |
|
items
|
data.timestamps | object | |
|
Tempo di convalida
|
metadata.validation_time | string |
Quando è stata eseguita la convalida. |
Documento: Download
Scarica il documento con tutte le firme raccolte finora.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
Valori restituiti
Contenuto del file di documento.
- Contenuto del file
- file
Documento: Elenco
Elenca i documenti nell'area di lavoro, più recente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Cerca ordini
|
query | string |
Frase da cercare nei titoli dei documenti e nei nomi di file. |
|
|
Offset
|
offset | integer |
Numero di documenti da ignorare. |
|
|
Limit
|
limit | integer |
Numero di documenti da restituire. Il valore predefinito è 10. |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
Documenti:
|
data | array of object |
Documenti. |
|
ID documento
|
data.uuid | string |
ID del documento. |
|
Nome del file
|
data.filename | string |
Nome del file. |
|
Stato documento
|
data.status | string |
Stato di firma del documento, ad esempio salvato (in attesa di firme), signed_partially o firmato. |
|
Caricato all'indirizzo
|
data.uploaded_at | date-time |
Quando il documento è stato caricato. |
|
Total
|
total | integer |
Numero totale di documenti corrispondenti. |
Documento: Estendere la validità della firma
Aggiorna le firme del documento per la validità o l'archiviazione a lungo termine.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
|
livello
|
level | True | string |
LT per la validità a lungo termine, LTA per l'archiviazione a lungo termine. |
Valori restituiti
- Corpo
- AcknowledgedResponse
Documento: Ottenere i firmatari
Elenca i firmatari di un documento con il relativo stato di firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
Firmatari:
|
data | array of object |
Firmatari del documento. |
|
ID firmatario
|
data.id | string |
ID del firmatario. |
|
Nome di battesimo
|
data.name | string |
Nome del firmatario. |
|
Cognome
|
data.surname | string |
Cognome del firmatario. |
|
Email
|
data.email | string |
Indirizzo di posta elettronica del firmatario. |
|
Stato firma
|
data.status | string |
Indica se il firmatario ha firmato: in sospeso, firmato, rifiutato, esaminato, confermato, negato o esaminato. |
|
Motivo rifiuto
|
data.rejection_reason | string |
Motivo per cui il firmatario ha dato quando rifiuta il documento. |
Documento: Ottenere lo stato
Ottiene lo stato di firma di un documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
Stato documento
|
data.document_status | string |
Stato della firma: salvato (in attesa di firme), signed_partially (alcuni hanno firmato) o firmato (tutti hanno firmato). |
Documento: Rimuovi
Rimuove un documento dall'area di lavoro.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
Valori restituiti
- Corpo
- AcknowledgedResponse
Firma: attendere il firmatario successivo
Attende fino a quando il firmatario successivo firma o rifiuta il documento, senza inviare alcun invito. Usarlo in un ciclo per attendere diversi firmatari senza eseguire il polling.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
Valori restituiti
- Corpo
- SigningEvent
Firma: attendere tutti i firmatari
Attende fino a quando ogni firmatario ha firmato o ha rifiutato il documento, quindi consente al flusso di continuare. Termina con lo stato timed_out quando si verifica il timeout.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
|
Timeout (minuti)
|
timeout_minutes | integer |
Tempo di attesa, espresso in minuti, prima di terminare con lo stato di timed_out. Il valore predefinito è 41760 (29 giorni), massimo è 43200 (30 giorni). |
Valori restituiti
- Corpo
- SigningWaitResponse
Firma: attendere un firmatario
Attende fino a quando un particolare firmatario firma il documento, quindi consente al flusso di continuare. Termina con lo stato timed_out quando si verifica il timeout.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
|
Messaggio di posta elettronica del firmatario
|
signer_email | True | string |
Messaggio di posta elettronica del firmatario da attendere, lo stesso messaggio di posta elettronica usato per invitarli. |
|
Timeout (minuti)
|
timeout_minutes | integer |
Tempo di attesa, espresso in minuti, prima di terminare con lo stato di timed_out. Il valore predefinito è 41760 (29 giorni), massimo è 43200 (30 giorni). |
Valori restituiti
- Corpo
- SigningWaitResponse
Firma: creare collegamenti del firmatario
Crea un collegamento di firma personale per ogni firmatario. I collegamenti vengono recapitati manualmente, ad esempio tramite posta elettronica o messaggio di Teams.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dei documenti
|
documents | True | array of string |
Documenti per cui creare collegamenti di firma. Usare i valori di ID documento dai passaggi di caricamento o elenco. |
|
ID firmatario
|
id | string |
ID personalizzato per il firmatario, univoco all'interno della richiesta. Obbligatorio quando l'indirizzo di posta elettronica è vuoto. |
|
|
Nome di battesimo
|
name | string |
Nome del firmatario. |
|
|
Cognome
|
surname | string |
Cognome del firmatario. |
|
|
Email
|
Indirizzo di posta elettronica del firmatario. Obbligatorio quando l'ID firmatario è vuoto. |
|||
|
Codice personale
|
personal_code | string |
Codice personale del firmatario. Necessario quando è necessaria l'autenticazione. |
|
|
Richiedi autenticazione
|
authentication_required | boolean |
In caso affermativo, il firmatario deve verificare la propria identità prima di aprire il collegamento. |
|
|
Posizione (solo ADoc)
|
position | string |
Posizione del processo del firmatario, visualizzata nelle firme ADoc. |
|
|
Reparto (solo ADoc)
|
structural_subdivision | string |
Il reparto del firmatario, mostrato nelle firme ADoc. |
|
|
Scopo della firma (solo ADoc)
|
signing_purpose | string |
Perché la persona firma, mostrata nelle firme ADoc. |
|
|
Callback URL
|
callback_url | string |
URL per notificare quando il documento è firmato. |
|
|
URL di callback di rifiuto
|
reject_callback_url | string |
URL da notificare quando un firmatario rifiuta il documento. |
|
|
Scadenza (minuti)
|
expire_after | integer |
Minuti fino alla scadenza del collegamento. Il valore predefinito è 2880 (due giorni). |
|
|
Mostra pulsante Rifiuta
|
show_reject_button | boolean |
Indica se i firmatari possono rifiutare il documento nella pagina di firma. Il valore predefinito è Sì. |
|
|
Elimina documento dopo (minuti)
|
delete_document_after | integer |
Minuti fino a quando il documento non viene eliminato dall'area di lavoro. Per impostazione predefinita, viene mantenuta. |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
Collegamenti di firma:
|
temporary_signing_links | array of object |
Un collegamento di firma per ogni firmatario. |
|
ID firmatario
|
temporary_signing_links.id | string |
ID personale per il firmatario. |
|
Nome di battesimo
|
temporary_signing_links.member_name | string |
Nome del firmatario. |
|
Cognome
|
temporary_signing_links.member_surname | string |
Cognome del firmatario. |
|
Email
|
temporary_signing_links.member_email | string |
Indirizzo di posta elettronica del firmatario. |
|
Collegamento di firma
|
temporary_signing_links.temporary_signing_link | string |
Il collegamento visualizzato dal firmatario per firmare il documento. |
|
ID collegamento di firma
|
temporary_signing_links.temporary_signing_link_id | string |
ID del collegamento di firma. |
|
Valido fino a
|
temporary_signing_links.valid_until | integer |
Quando il collegamento scade, come timestamp Unix. |
|
Documenti:
|
documents | array of object |
I documenti per cui sono stati creati i collegamenti. |
|
ID documento
|
documents.uuid | string |
ID del documento. |
|
Nome del file
|
documents.filename | string |
Nome del file di documento. |
Firma: Creare un collegamento condiviso
Crea un collegamento di firma che chiunque può aprire per firmare i documenti. Lo dia a te stesso.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID dei documenti
|
documents | True | array of string |
Documenta i segni di collegamento. Usare i valori di ID documento dai passaggi di caricamento o elenco. |
|
Callback URL
|
callback_url | string |
URL per notificare quando il documento è firmato. |
|
|
Scadenza (minuti)
|
expire_after | integer |
Minuti fino alla scadenza del collegamento. Il valore predefinito è 2880 (due giorni). |
|
|
Elimina documento dopo (minuti)
|
delete_document_after | integer |
Minuti fino a quando il documento non viene eliminato dall'area di lavoro. Per impostazione predefinita, viene mantenuta. |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
Collegamento di firma
|
data.signing_link | string |
Il collegamento chiunque può aprire per firmare. |
|
ID collegamento di firma
|
data.signing_link_id | string |
ID del collegamento, per "Firma: Elimina collegamento". |
|
Valido fino a
|
data.valid_until | integer |
Quando il collegamento scade, come timestamp Unix. |
Firma: elimina collegamento
Elimina un collegamento di firmatario o un collegamento condiviso prima della scadenza. Impossibile eliminare i collegamenti di invito.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID collegamento di firma
|
temporarySigningLinkId | True | string |
ID collegamento di firma dall'output di "Firma: Creare collegamenti firmatari" o "Firma: Crea collegamento condiviso". |
Valori restituiti
- Corpo
- AcknowledgedResponse
Firma: invita tramite posta elettronica
Invita una persona a firmare il documento. Mark Sign invia l'invito tramite posta elettronica.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
|
Nome di battesimo
|
name | True | string |
Nome del firmatario. |
|
Cognome
|
surname | True | string |
Cognome del firmatario. |
|
Email
|
True |
Indirizzo di posta elettronica del firmatario. |
||
|
Language
|
language | string |
Lingua dell'invito. Il valore predefinito è Lituano. |
|
|
URL operazione riuscita
|
success_url | string |
Dove inviare il firmatario dopo aver completato la firma. |
|
|
Purpose
|
purpose | string |
Perché la persona è invitata. Scegliere rivedi per invitare solo per la visualizzazione. |
|
|
Callback URL
|
callback_url | string |
URL per notificare quando il documento è firmato. |
Valori restituiti
- Corpo
- AcknowledgedResponse
Firma: Invitare per URL
Aggiunge un firmatario al documento senza inviare un messaggio di posta elettronica e restituisce il relativo collegamento di invito personale da recapitare. Il collegamento non scade e non può essere eliminato; usare "Firma: Creare collegamenti firmatari" quando sono necessari collegamenti che è possibile revocare.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | string |
ID del documento, dall'output di "Document: Upload", "Document: Upload" o "Document: List". |
|
Nome di battesimo
|
name | True | string |
Nome del firmatario. |
|
Cognome
|
surname | True | string |
Cognome del firmatario. |
|
Email
|
True |
Indirizzo di posta elettronica del firmatario. |
||
|
URL operazione riuscita
|
success_url | string |
Dove inviare il firmatario dopo aver completato la firma. |
|
|
Purpose
|
purpose | string |
Perché la persona è invitata. Scegliere rivedi per invitare solo per la visualizzazione. |
|
|
Callback URL
|
callback_url | string |
URL per notificare quando il documento è firmato. |
Valori restituiti
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
|
URL invito
|
data.invitation_url | string |
Collegamento alla pagina di firma personale da recapitare al firmatario. |
Definizioni
SigningEvent
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID documento
|
uuid | string |
ID del documento. |
|
Stato documento
|
status | string |
Stato di firma del documento, ad esempio firmato o signed_partially. Un rifiuto viene visualizzato negli stati del firmatario. |
|
Conteggio firmatario
|
members_count | integer |
Quante persone sono state invitate a firmare. |
|
Conteggio con segno
|
signed_members_count | integer |
Quante persone hanno firmato. |
|
Firmatari:
|
members | array of object |
Tutti invitati a firmare. |
|
ID firmatario
|
members.id | string |
ID del firmatario. |
|
Nome di battesimo
|
members.member_name | string |
Nome del firmatario. |
|
Cognome
|
members.member_surname | string |
Cognome del firmatario. |
|
Email
|
members.member_email | string |
Indirizzo di posta elettronica del firmatario. |
|
Stato firma
|
members.status | string |
Stato del firmatario, ad esempio in sospeso, firmato o rifiutato. |
AcknowledgementResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Status
|
status | RequestStatus |
Stato della richiesta. |
SigningWaitResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Stato documento
|
document_status | string |
Modalità di fine dell'attesa: firmato, rifiutato o timed_out. |
|
Rifiutato da
|
rejected_by | string |
Chi ha rifiutato il documento, se è stato rifiutato. |
|
Motivo rifiuto
|
rejection_reason | string |
Motivo per cui il firmatario ha dato, se il documento è stato rifiutato. |
RequestStatus
file
Si tratta del tipo di dati di base 'file'.