Questo articolo ti guiderà attraverso il processo di invio di un documento per la firma utilizzando l'API eSignature di Sign.Plus.
Seguendo questi passaggi, creerai una busta, aggiungerai un documento, imposterai un destinatario, inserirai un'annotazione di firma e infine invierai la busta per la firma.
Prerequisiti
- Un account Sign.Plus con un piano API
- Il tuo
Personal Access Token
Passaggio 1: crea una busta
Una busta è un contenitore per i documenti da firmare da parte dei destinatari.
- Invia una richiesta all'endpoint POST /v2/envelope per creare una nuova busta.
{
"name": "La mia fantastica busta",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Includi la tua chiave API nell'header
Authorization. -
In caso di successo, riceverai un oggetto
Envelope.{ "id": "<string>" ... } -
Salva l'
idcomeenvelope_id
Passaggio 2: aggiungi un documento alla tua busta
-
Usa l'endpoint POST /v2/envelope/{envelope_id}/document per aggiungere un documento.
-
Sostituisci
{envelope_id}con l'ID ricevuto nel Passaggio 1. - Invia una richiesta POST con il file del documento nel corpo della richiesta come
multipart/form-data. -
Se l'operazione riesce, riceverai un oggetto
Documentcome risposta.{ "id": "<string>" ... } -
Salva
idcomedocument_idper usarlo in seguito.
Passaggio 3: imposta un destinatario per la tua busta
-
Utilizza l'endpoint POST /v2/envelope/{envelope_id}/signing_steps per aggiungere un destinatario.
-
Sostituisci
{envelope_id}con l'ID della tua busta. -
Invia una richiesta
POSTcon il seguente corpo JSON:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
In caso di successo, riceverai un array di
SigninStep. -
Scorri l'array e prendi il nome
iddel destinatario per il quale vuoi aggiungere il riquadro della firma (annotazione di firma). Salva questoidcomerecipient_id.
Passaggio 4: inserisci un'annotazione di firma nel tuo documento
Prima di aggiungere un'annotazione di firma, assicurati di aver definito la tua firma sulla piattaforma Sign.Plus.
- Usa l'endpoint POST /v2/envelope/{envelope_id}/annotation per aggiungere un'annotazione di firma.
- Sostituisci
{envelope_id}con l'ID della tua busta. - Invia una richiesta
POSTcon il seguente corpo JSON:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Sostituisci
<recipient_id>e<document_id>con i valori appropriati.
Passaggio 5: invia la tua busta per la firma
- Usa l'endpoint POST /v2/envelope/{envelope_id}/send per inviare la busta.
- Sostituisci
{envelope_id}con l'ID della tua busta. - Invia una richiesta
POSTa questo endpoint. - In caso di successo, la busta verrà inviata al destinatario per la firma.
Conclusione
Hai ora inviato con successo un documento per la firma utilizzando l'API eSignature di Sign.Plus. Il destinatario riceverà una notifica via email con un link per firmare il documento.
Per informazioni più dettagliate su ciascun endpoint API utilizzato in questo processo, consulta la nostra documentazione API.