Penneo Sign Production (anteprima)
Penneo trasforma processi complessi in un'esperienza semplice e incentrata sugli esseri umani. Grazie all'integrazione di firme digitali in flussi di lavoro automatizzati, la piattaforma consente di convalidare chi ha approvato i dati e quando, riducendo al contempo i carichi amministrativi garantendo al tempo stesso la conformità e la sicurezza complete. Questo connettore consente di inviare documenti per la firma.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | 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 di Azure per enti pubblici - Azure cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | 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 | Di alta qualità | 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 | |
|---|---|
| Nome | Supporto di Penneo |
| URL | https://www.support.penneo.com |
| Metadati del connettore | |
|---|---|
| Editore | Integrazione di Penneo |
| source | Swagger |
| Sito web | https://penneo.com |
| Informativa sulla privacy | https://penneo.com/privacy-policy |
| Categories | Produttività |
Penneo Sign
Penneo trasforma processi complessi in un'esperienza semplice e incentrata sugli esseri umani. Grazie all'integrazione di firme digitali in flussi di lavoro automatizzati, la piattaforma consente di convalidare chi ha approvato i dati e quando, riducendo al contempo i carichi amministrativi garantendo al tempo stesso la conformità e la sicurezza complete.
Prerequisiti
Per usare questo connettore, è necessario un account Penneo attivo.
Azioni supportate
Creare un nuovo file case
Crea un nuovo file case in Penneo con i documenti e i firmatari specificati. Il file del caso verrà creato in Penneo e verrà restituito un UUID e un payloadHash che può essere usato per controllare lo stato di creazione tramite l'endpoint di stato della coda.
Controllare lo stato dell'attività
Recupera lo stato corrente di un casefile specificando l'UUID del processo e payloadHash. Questo endpoint viene usato per eseguire il polling dello stato di completamento del processo dopo l'invio di una richiesta di creazione del file del caso. L'endpoint è limitato a 20 richieste al minuto per combinazione uuid-payloadHash.
Ottenere i dettagli del file del caso
Recupera i dettagli di un file case specifico da Penneo in base a casefileId. Sono inclusi i firmatari, i documenti e lo stato corrente.
Scaricare il documento
Scarica il contenuto di un documento da Penneo come stringa con codifica Base64. Per impostazione predefinita, viene restituita la versione firmata del documento; usare il signed parametro per ottenere invece la versione senza segno. Se il file del caso include più documenti, assicurarsi di eseguire il ciclo su ogni documento.
Recupero delle credenziali
Il connettore è stato configurato per l'uso di OAuth con concessione del codice di autorizzazione. Gli utenti dovranno accedere con le credenziali normali quando usano il connettore.
Getting Started
Creazione di un file case
Preparare i documenti:
- Convertire i documenti PDF nella codifica base64
- Verificare che i documenti siano file PDF validi
Configurare i firmatari:
- Specificare il nome e il messaggio di posta elettronica del firmatario (obbligatorio)
- Facoltativamente, specificare ruolo, lingua, ordine di firma e così via.
- Configurare le notifiche di posta elettronica e i modelli di posta elettronica personalizzati, se necessario
Creare il file del caso:
- Usare l'azione "Crea un nuovo file del caso"
- Compilare i dettagli del file del caso:
- Title
- Documenti (PDF con codifica Base64)
- Firmatari (con nomi e dettagli facoltativi)
- Impostazioni facoltative (scadenza, lingua, visibilità e così via)
Controllare lo stato di creazione di CaseFile:
- Dopo aver creato un file case, si riceverà un UUID e payloadHash
- Usare l'azione "Controlla stato processo" per eseguire il polling del completamento del processo
- Rispettare il limite di frequenza di 20 richieste al minuto per combinazione uuid-hash
Nota: è possibile controllare il funzionamento di ogni campo controllando https://penneo.readme.io/reference/createcasefile.
Recupero di un file case e dei relativi documenti
Ottenere i dettagli del file del caso:
- Usare l'azione "Ottenere i dettagli del file del caso" con l'ID del file del caso
- La risposta include lo stato del file del caso, i firmatari e l'elenco dei documenti (con i relativi ID documento)
Scaricare un documento:
- Usare l'azione "Scarica documento" con l'ID documento ottenuto dai dettagli del file del caso
- La risposta contiene il contenuto del documento come stringa con codifica Base64, che è possibile decodificare per recuperare il file PDF
Problemi noti e limitazioni
Limitazione della frequenza: l'endpoint di controllo dello stato del processo è limitato a 20 richieste al minuto per ogni combinazione di uuid-hash. Implementare la logica di ripetizione dei tentativi appropriata con backoff esponenziale.
Elaborazione asincrona: la creazione del file case è asincrona. È necessario usare l'endpoint dello stato del processo per controllare il completamento anziché prevedere risultati immediati.
Codifica Base64: i documenti devono essere codificati in base64. Assicurarsi che la codifica sia corretta per evitare errori di richiesta(è possibile usare la funzione stringa base64 in Power Platform per codificare i file PDF binari).
Ambiente di produzione: questo connettore è configurato per l'ambiente di produzione Penneo (
app.penneo.com).Dimensioni documento: i documenti di grandi dimensioni potrebbero richiedere più tempo per l'elaborazione. Prendere in considerazione i limiti delle dimensioni dei documenti quando si esegue la codifica in base64.
Istruzioni per la distribuzione
Eseguire i comandi seguenti e seguire i prompt:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx
Azioni
| Controllare lo stato dell'attività |
Recupera lo stato corrente di un processo asincrono fornendo l'UUID del processo e payloadHash. Questo endpoint viene usato per eseguire il polling dello stato di completamento del processo dopo l'invio di una richiesta di creazione del file del caso. L'azione è limitata a 20 richieste al minuto per combinazione uuid-payloadHash. |
| Creare un nuovo file case |
Crea un nuovo file case in Penneo con i documenti e i firmatari specificati. Il file del caso verrà creato in modo asincrono e verrà restituito un UUID del processo e un payloadHash che può essere usato per controllare lo stato di creazione tramite l'azione Controlla stato processo. È possibile configurare firmatari, documenti, ordine di firma, notifiche tramite posta elettronica, controllo di accesso e varie altre impostazioni del file del caso. |
| Ottenere i dettagli del file del caso |
Recupera i dettagli di un file di caso specifico da Penneo, inclusi i firmatari, i documenti e lo stato corrente. Stato del file del caso: 0=new, 1=pending, 2=rejected, 3=deleted, 4=signed, 5=completed, 6=failed, 7=expired, 8=anonimizzato. Usare lo stato 5 (completato) come trigger per scaricare i documenti firmati. |
| Scaricare il documento |
Scarica il contenuto di un documento da Penneo come stringa con codifica Base64. Per impostazione predefinita, viene restituita la versione firmata del documento. |
Controllare lo stato dell'attività
Recupera lo stato corrente di un processo asincrono fornendo l'UUID del processo e payloadHash. Questo endpoint viene usato per eseguire il polling dello stato di completamento del processo dopo l'invio di una richiesta di creazione del file del caso. L'azione è limitata a 20 richieste al minuto per combinazione uuid-payloadHash.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
uuid
|
uuid | True | uuid |
UUID del processo da controllare. Viene restituito quando viene creato il processo. |
|
payloadHash
|
payloadHash | True | string |
Hash SHA-256 del payload. Viene restituito quando viene creato il processo e viene usato per verificare l'autenticità della richiesta. |
Valori restituiti
- Corpo
- QueueJob
Creare un nuovo file case
Crea un nuovo file case in Penneo con i documenti e i firmatari specificati. Il file del caso verrà creato in modo asincrono e verrà restituito un UUID del processo e un payloadHash che può essere usato per controllare lo stato di creazione tramite l'azione Controlla stato processo. È possibile configurare firmatari, documenti, ordine di firma, notifiche tramite posta elettronica, controllo di accesso e varie altre impostazioni del file del caso.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Titolo
|
title | True | string |
Titolo del file case. |
|
sendAt
|
sendAt | integer |
Timestamp quando deve essere inviato il file del case. Null = immediatamente |
|
|
nome
|
name | True | string |
Nome del firmatario |
|
Ruolo
|
role | string |
Ruolo per il firmatario. Consentito: lettere, numeri, spazi, virgola, sottolineatura, trattino. Deve iniziare con una lettera/numero e non deve terminare con uno spazio. |
|
|
email
|
Messaggio di posta elettronica del firmatario. Penneo gestirà tutte le comunicazioni |
|||
|
failUrl
|
failUrl | uri |
URL di reindirizzamento dopo un errore |
|
|
language
|
language | string |
Lingua del firmatario |
|
|
emailText
|
emailText | string |
Testo personalizzato per il messaggio di posta elettronica della richiesta di firma. L'impostazione predefinita è il modello aziendale, se non specificato. |
|
|
signOrder
|
signOrder | integer |
Ordine di firma. 0 indica che non viene applicato alcun ordine. |
|
|
successUrl
|
successUrl | uri |
URL di reindirizzamento dopo l'esito positivo |
|
|
emailOggetto
|
emailSubject | string |
Oggetto del messaggio di posta elettronica della richiesta di firma. L'impostazione predefinita è il modello aziendale, se non specificato. |
|
|
reminderInterval
|
reminderInterval | integer |
Giorni prima dell'invio del promemoria |
|
|
reminderEmailText
|
reminderEmailText | string |
Testo personalizzato per il messaggio di posta elettronica di promemoria. L'impostazione predefinita è il modello aziendale, se non specificato. |
|
|
completedEmailText
|
completedEmailText | string |
Testo personalizzato per il messaggio di posta elettronica completato. L'impostazione predefinita è il modello aziendale, se non specificato. |
|
|
reminderEmailSubject
|
reminderEmailSubject | string |
Oggetto del messaggio di posta elettronica di promemoria. L'impostazione predefinita è il modello aziendale, se non specificato. |
|
|
completedEmailSubject
|
completedEmailSubject | string |
Oggetto del messaggio di posta elettronica completato. L'impostazione predefinita è il modello aziendale, se non specificato. |
|
|
enableInsecureSigning
|
enableInsecureSigning | boolean |
Se true, il firmatario può usare firme di tocco (disegno, testo, caricamento di immagini) |
|
|
insecureSigningMethods
|
insecureSigningMethods | array of string |
Metodi di firma non sicuri consentiti. Il valore predefinito è l'impostazione della società se vuoto. |
|
|
secureSigningMethods
|
secureSigningMethods | array of string |
Metodi di firma elettronica sicuri consentiti. Esegue l'override del file del caso e delle impostazioni del cliente quando impostato. |
|
|
vatin
|
vatin | string |
Numero di partita IVA della società del firmatario |
|
|
ssnType
|
ssnType | string |
Tipo di SSN/mobile. Esempio di 'dk:cpr', 'se:pin', 'no:nin', 'be:nrn', 'fi:pic' o 'sms'. Il valore predefinito è "legacy" |
|
|
activeAt
|
activeAt | integer |
Timestamp di attivazione |
|
|
expireAt
|
expireAt | integer |
Timestamp di scadenza |
|
|
accessControl
|
accessControl | boolean |
Se abilitata, SSN/VATIN/phone viene convalidato prima dell'accesso |
|
|
emailFormat
|
emailFormat | string |
Definisce il formato di posta elettronica |
|
|
Onbehalfof
|
onBehalfOf | string |
L'azienda o l'organizzazione che questo firmatario firma per conto di |
|
|
storeAsContact
|
storeAsContact | boolean |
Se true, il firmatario verrà archiviato come contatto in Penneo |
|
|
socialSecurityNumberPlain
|
socialSecurityNumberPlain | string |
Numero di telefono o SSN del firmatario (formato E.164 consigliato) |
|
|
expireAt
|
expireAt | integer |
Timestamp alla scadenza del file del caso. Se non specificato, vengono applicate le impostazioni predefinite |
|
|
language
|
language | string |
La lingua del file case verrà applicata per ogni firmatario che non dispone di un set di lingue |
|
|
pdf
|
True | string |
PDF con codifica Base64 |
|
|
firmabile
|
signable | boolean |
True crea un documento firmabile. False, il documento viene aggiunto come allegato e non è firmabile. |
|
|
roles
|
roles | array of string |
Ruoli firmatari autorizzati a firmare questo documento. L'impostazione predefinita è tutti i firmatari se vuoti. |
|
|
Titolo
|
title | True | string |
Titolo del documento |
|
documentOrder
|
documentOrder | integer |
Ordine di firma del documento. Per impostazione predefinita, viene specificato l'ordine specificato. |
|
|
metadati
|
metaData | string |
Metadati del documento, ricercabili in Penneo |
|
|
sensitiveData
|
sensitiveData | boolean |
Se true, i firmatari devono convalidare la propria identità prima di accedere ai documenti. Disabilita gli allegati di posta elettronica per i documenti firmati. |
|
|
signOnMeeting
|
signOnMeeting | boolean |
Specifica se i documenti devono essere firmati durante una riunione. |
|
|
visibilityMode
|
visibilityMode | integer |
0 = I firmatari visualizzano tutti i documenti. 1 = I firmatari vedono solo i documenti che devono firmare. |
|
|
disableEmailAttachments
|
disableEmailAttachments | boolean |
Disabilita gli allegati di posta elettronica per i documenti firmati nei messaggi di posta elettronica di finalizzazione. Sottoposto a override se sensitiveData è true. |
|
|
disableNotificationsOwner
|
disableNotificationsOwner | boolean |
Se il proprietario del file del caso true non riceverà notifiche per il file del caso. |
|
|
folderId
|
folderId | integer |
ID cartella in cui inserire il casefile |
|
|
metadati
|
metaData | string |
Metadati del file del caso, ricercabili in Penneo |
|
|
riferimento
|
reference | string |
Il riferimento al file del caso verrà visualizzato nell'applicazione Web Penneo |
|
|
nome
|
name | True | string |
Nome del destinatario |
|
email
|
True |
Indirizzo di posta elettronica del destinatario |
Valori restituiti
- Corpo
- JobResponse
Ottenere i dettagli del file del caso
Recupera i dettagli di un file di caso specifico da Penneo, inclusi i firmatari, i documenti e lo stato corrente. Stato del file del caso: 0=new, 1=pending, 2=rejected, 3=deleted, 4=signed, 5=completed, 6=failed, 7=expired, 8=anonimizzato. Usare lo stato 5 (completato) come trigger per scaricare i documenti firmati.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Case File Id
|
caseFileId | True | integer |
ID del file del case da recuperare. Recuperare l'ID del file del caso con l'azione "Controlla stato processo". |
Valori restituiti
Dettagli di un file di caso recuperato dall'archivio protetto di Penneo.
- Corpo
- CaseFileDetails
Scaricare il documento
Scarica il contenuto di un documento da Penneo come stringa con codifica Base64. Per impostazione predefinita, viene restituita la versione firmata del documento.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID documento
|
documentId | True | integer |
ID del documento da scaricare. Recuperare i documentId con l'azione "Ottenere i dettagli del file del caso". |
|
Firmato
|
signed | boolean |
Ottiene il documento firmato o non firmato. Per impostazione predefinita, il documento firmato viene restituito se il documento è stato firmato. |
Valori restituiti
- Corpo
- DocumentContent
Definizioni
JobResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
jobs
|
jobs | array of Job |
Matrice di processi creati (in genere contiene un processo) |
|
stato
|
status | string |
Stato della richiesta di creazione del processo |
|
message
|
message | string |
Messaggio leggibile sulla creazione del processo |
Job
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
uuid
|
uuid | uuid |
Identificatore univoco per il processo che può essere usato per controllare lo stato |
|
uuid
|
payload.uuid | uuid |
UUID del file del caso creato |
|
bundleUuid
|
payload.bundleUuid | uuid |
UUID del bundle contenente il file del case |
|
etlVersionUuid
|
payload.etlVersionUuid | uuid |
UUID della versione ETL usata per l'elaborazione |
|
organizationUuid
|
payload.organizationUuid | uuid |
UUID dell'organizzazione proprietaria del file del caso |
|
dati personalizzati
|
payload.customData | object |
Metadati e contesto aggiuntivi per il processo |
|
createdAt
|
createdAt | date-time |
Timestamp ISO 8601 al momento della creazione del processo |
|
payloadHash
|
payloadHash | string |
Hash SHA-256 del payload, usato per la verifica durante il controllo dello stato del processo |
QueueJob
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
type
|
type | string |
Tipo di processo della coda ,ad esempio 'casefile_creation') |
|
uuid
|
uuid | uuid |
Identificatore univoco per il processo |
|
result
|
result | object |
Risultato dell'esecuzione del processo in coda, restituito come JSON al termine del processo. Contiene il risultato e i dati pertinenti. |
|
stato del lavoro
|
jobStatus | string |
Stato attuale del lavoro. Valori possibili 'in sospeso' (in attesa di elaborazione), 'elaborazione' (attualmente in esecuzione), 'completed' (completato correttamente), 'failed' (esecuzione non riuscita), 'aborted_duplicated' (interrotta a causa della duplicazione) |
|
payload
|
payload | object |
Payload originale inviato con il processo, archiviato come JSON. Contiene i dati e i metadati del file del case. |
|
Tentativi
|
retries | integer |
Numero di tentativi di ripetizione del processo dopo un errore |
|
createdAt
|
createdAt | date-time |
Data e ora di creazione del processo di accodamento |
|
updatedAt
|
updatedAt | date-time |
Data e ora dell'ultimo aggiornamento del processo della coda |
|
maxRetries
|
maxRetries | integer |
Numero massimo di tentativi consentiti per questo processo prima che venga contrassegnato come non riuscito |
|
payloadHash
|
payloadHash | string |
Hash SHA-256 del payload, usato per scopi di verifica e sicurezza |
|
errorMessage
|
errorMessage | string |
Messaggio di errore che descrive il motivo per cui il processo non è riuscito, se applicabile. Presente solo quando jobStatus è 'failed'. |
CcRecipient
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
Nome del destinatario |
|
email
|
Indirizzo di posta elettronica del destinatario |
CaseFileDetails
Dettagli di un file di caso recuperato dall'archivio protetto di Penneo.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
userId
|
userId | integer |
ID dell'utente proprietario del file del caso. |
|
ID cliente
|
customerId | integer |
ID del cliente a cui appartiene il file del caso. |
|
Firmatari
|
signers | array of SignerDetails |
Elenco dei firmatari nel file del caso. |
|
id
|
id | integer |
ID del file case. |
|
Titolo
|
title | string |
Titolo del file case. |
|
stato
|
status | integer |
Stato del file del caso. |
|
Documenti
|
documents | array of DocumentDetails |
Elenco di documenti nel file del caso. |
|
expireAt
|
expireAt | integer |
Timestamp UNIX alla scadenza del file case. |
|
ccRecipients
|
ccRecipients | array of CcRecipient |
Elenco dei destinatari cc che ricevono una copia dei documenti firmati. |
|
creato
|
created | integer |
Timestamp UNIX al momento della creazione del file case. |
|
attivato
|
activated | integer |
Timestamp UNIX quando il file del case è stato attivato. |
|
aggiornato
|
updated | integer |
Timestamp UNIX dell'ultimo aggiornamento del file case. |
|
completato
|
completed | integer |
Timestamp UNIX al termine del file case. |
SignerDetails
Firmatario in un file del caso.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
Nome del firmatario. |
|
id
|
id | integer |
ID firmatario. |
|
signingRequest
|
signingRequest | SigningRequestDetails |
Richiesta di firma associata a un firmatario. |
SigningRequestDetails
Richiesta di firma associata a un firmatario.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID richiesta di firma. |
|
email
|
string |
Messaggio di posta elettronica del firmatario. |
|
|
stato
|
status | integer |
Stato della richiesta di firma. |
DocumentDetails
Documento in un file del caso.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
ID documento. Utilizzare questa opzione per scaricare il documento con l'azione "Scarica documento". |
|
stato
|
status | integer |
Stato del documento. |
|
firmabile
|
signable | boolean |
True se il documento è firmabile. |
DocumentContent
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Contenuto del documento
|
content | byte |
Contenuto con codifica Base64 del documento. |