POST /esignglobal/v1/envelope/create
Descrizione dell'interfaccia
Crea una busta in stato di bozza.
Parametri di richiesta
Nome parametro | Tipo | Obbligatorio | Descrizione |
subject | string | true | Oggetto della busta, esempio: "Lettera di offerta" |
remark | string | false | Note sulla busta, lunghezza massima 1000 caratteri |
signerSettings | object | false | Operazioni consentite al firmatario |
| allowTransfer | boolean | false | Indica se il firmatario può trasferire questa busta a qualcun altro per la firma, predefinito false true- Consente al firmatario nella busta di avere il potere di trasferire la busta ad altri; false- Non consente al firmatario nella busta di avere il potere di trasferire la busta ad altri; |
| allowModifyName | boolean | false | Indica se il firmatario può modificare il nome, valido solo per la firma del modello, predefinito false true- Consente al firmatario di modificare il nome false- Il firmatario non è autorizzato a modificare il nome |
expireAfterSeconds | long | false | Scadenza della busta: dopo quanti secondi la busta scade Intervallo di scadenza: 86.400 secondi (1 giorno) ~ 7.776.000 secondi (90 giorni). |
redirectUrl | string | false | Indirizzo di reindirizzamento al completamento della firma (lunghezza 2048), deve essere un indirizzo http valido |
callBackUrl | string | false | Indirizzo di callback (lunghezza 500), deve essere conforme all'indirizzo del protocollo https/http |
Esempio di richiesta
{
"subject": "api subject fdsfasdfafs",
"remark": "This is a remark",
"expireAfterSeconds": 888640,
"redirectUrl": "https://www.example.com"
}
Parametri di risposta
Nome parametro | Tipo | Descrizione |
envelopeId | string | ID busta |
envelopeStatus | int | Stato della busta 0 - Creato (bozza) 1 - In fase di firma 2 - Completato 3-Scaduto 5-Revocato |
Esempio di risposta
{
"code": "0",
"data": {
"envelopeId": "9fbe6c8190824227bde29136b0145c81",
"envelopeStatus": 0
},
"message": "success"
}