API di piattaforma > JamioPlug > JamioPlug Document Automation > Firma elettronica

Abilita la funzionalità di firma elettronica avanzata di un documento, creando un certificato di firma emesso per una specifica identità, utilizzabile entro 365 giorni dalla sua attivazione.

Metodo

PlugDocumentAutomation /EnableAdvancedSignature

Input
Nome	Descrizione	Tipo	Opzionale
serverAddress	Indirizzo server da un Dominio esterno (per il Dominio della sessione corrente, utilizzare nullo o vuoto).	String	Y
token	Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).	String	Y
identityReference	Collegamento all'identità che deve firmare il documento.	Reference
sendNotification	Se true, invia una notifica email di riepilogo.	Boolean
senderId	Identificativo che compare come mittente del messaggio che autorizza la transazione. Valore di default Jamio PaaS.	String	Y
subject	Testo, in composizione con placeholder, che viene inserito come oggetto del messaggio email.	String	Y
startMessage	Testo, in composizione con placeholder, che viene inserito come parte iniziale del corpo del messaggio email. Il valore di default è "Sei stato abilitato a firmare i documenti. Utilizzerai il codice segreto che hai fornito:" seguito dal valore inserito nel parametro secretCode.	String	Y
endMessage	Testo, in composizione con placeholder, che viene inserito come parte finale del corpo del messaggio email. Il valore di default è un testo vuoto.	String	Y
fields	Dato strutturato che consente di sostituire eventuali placeholder presenti nei parametri startMessage, endMessage e subject con il corrispondente elemento presente nella struttura, avente nome uguale a quello del placeholder. Il nome del campo del dato strutturato rappresenta il placeholder da inserire nel testo del messaggio, mentre il valore del campo del dato strutturato il testo che sarà riportato nel messaggio in sostituzione del placeholder.	Dataset	Y
fieldMapping	Nome dei campi disponibili nella risorsa referenziata da identityReference per valorizzare il cognome dell'identità, il nome dell'identità, il codice fiscale dell'identità. I nomi dei campi, di tipo testo, che è possibile specificare nel dato strutturato sono firstName, lastName, fiscalCode.	Dataset	Y
secretCode	Codice di 8 cifre che rappresenta la password dell'utente associata al certificato di firma.	String
testMode	True se è richiesta l'esecuzione del metodo in modalità test. Se non specificato, viene effettuata l'esecuzione del metodo in modalità live.	Boolean	Y

Commenti

Il metodo EnableTransactionalAdvancedSignature verifica che per l'identità specificata nel campo collegamento identityReference:

•sia disponibile un documento di riconoscimento valido. La verifica è effettuata sulle proprietà IdentificationDocument, IdentificationCodeExpiryDate e IdentificationCode dell'identità;

•esiste un recapito email ed esso sia validato. La verifica è effettuata sulle proprietà ServiceEmail e ServiceEmailValidated dell'identità;

•sia disponibile un recapito telefonico ed esso sia validato. La verifica è effettuata sulle proprietà ServiceMobilePhoneNumber e ServiceMobilePhoneNumberValidated dell'identità

Se l'identità ha le caratteristiche utili, il metodo EnableAdvancedSignature crea un certificato di firma elettronica utilizzabile per la durata di 365 giorni con password pari al valore specificato nel parametro secretCode ed invia, se il parametro testMode è false, un messaggio email di riepilogo all'identità indicata nel parametro identityReference. Se il parametro testMode è true, l'invio dei messaggi non viene effettuato e il certificato non viene creato. Il mancato recapito o l'errore nell'invio della notifica non influenza la creazione del certificato.

Il certificato creato resta valido per ulteriori 365 giorni dalla scadenza del periodo di usabilità.

Il metodo si comporta come segue:

Restituisce	Condizione
Errore PLUG_MissingIdentificationDocument	Se l'identità referenziata in identityReference non dispone di un documento di riconoscimento.
Errore PLUG_InvalidIdentificationCode	Se l'identità referenziata in identityReference dispone di un documento di riconoscimento scaduto.
Errore PLUG_MissingIdentificationCode	Se l'identità referenziata in identityReference non dispone del codice del documento di riconoscimento.
Errore PLUG_MissingEmailAddress	Se l'identità referenziata in identityReference non dispone di un indirizzo email.
Errore PLUG_InvalidEmailAddress	Se l'identità referenziata in identityReference dispone di un indirizzo email, ma esso non è validato.
Errore PLUG_MissingPhoneAddress	Se l'identità referenziata in identityReference non dispone di un recapito telefonico.
Errore PLUG_InvalidPhoneAddress	Se l'identità referenziata in identityReference dispone di un recapito telefonico, ma esso non è validato.
Errore ERR_ServiceInvocationException	Se fieldMapping riporta il nome di campi diversi dal tipo testo breve o testo lungo presenti nella risorsa referenziata da identityReference.
Errore PLUG_Error	Se il codice riportato in secretCode non può essere utilizzato come password dell'utente per il certificato di firma.
Errore Certificate already exists. - PLUG_Error	Se per l'identità specificata esiste già un certificato di firma con il transactionId specificato.
Errore SecretCode must contain 8 characters. - PLUG_Error	Se il codice riportato in secretCode non contiene 8 caratteri.

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di Lettura sulla risorsa referenziata dal collegamento identityReference.