Questo articolo ti guiderà attraverso il processo di invio di un documento per la firma utilizzando la Sign.Plus eSignature API.
A seguito di questi passaggi, si creerà una busta, si aggiungerà un documento, si imposterà un destinatario, si inserirà una annotazione della firma e infine si invierà la busta per la firma.
Prerequisiti
- Un account Sign.Plus con un piano API
- Il Tuo
Token Di Accesso Personale
Passo 1: Crea una Busta
Una busta è un contenitore per i documenti che devono essere firmati dai destinatari.
- Invia una richiesta all'endpoint POST /v2/envelope per creare una nuova busta.
{
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Includi la tua chiave API nell'intestazione
Authorization
. -
Con successo, riceverai un oggetto
Envelope
.{ "id": "<string>" ... }
-
Salva l'id
come la
envelope_id
Passo 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 che hai ricevuto nel passaggio 1. - Invia una richiesta POST con il file del documento nel corpo della richiesta come
multipart/form-data.
-
Con successo, riceverai un
Document
object come risposta.{ "id": "<string>" ... }
-
Salva l'ID
come l'
document_id
per più tardi.
Passo 3: Imposta un destinatario per la tua busta
-
Usa l'endpoint POST /v2/envelope/{envelope_id}/signing_steps per aggiungere un destinatario.
-
Sostituisci
{envelope_id}
con il tuo ID busta. -
Invia una richiesta
POST
con il seguente corpo JSON:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john. oe@esempio. om", "ruolo": "SIGNER"
} ] } ] } -
Al successo, riceverai un array di
SigninStep
. -
Sfoglia l'array e prendi il nome
id
del destinatario per il quale vuoi aggiungere la cornice della firma (annotazione della firma). Salva questoid
comerecipient_id
.
Passo 4: Inserisci un'annotazione di firma nel documento
Prima di aggiungere un'annotazione della firma, assicurati di aver definito la tua firma nella piattaforma Sign.Plus.
- Utilizzare l'endpoint POST /v2/envelope/{envelope_id}/annotazione per aggiungere un'annotazione della firma.
- Sostituisci
{envelope_id}
con il tuo ID busta. - Invia una richiesta
POST
con la seguente JSON body:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Sostituire
<recipient_id>
e<document_id>
con i valori appropriati.
Passo 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 il tuo ID busta. - Invia una richiesta
POST
a questo endpoint. - Al successo, la busta verrà inviata al destinatario per la firma.
Conclusione
Ora hai inviato con successo un documento per la firma utilizzando l'API Sign.Plus eSignature . Il destinatario riceverà una notifica via email con un link per firmare il documento.
Per informazioni più dettagliate su ogni endpoint API utilizzato in questo processo, si prega di fare riferimento alla nostra documentazione API .