Creare busta

POST /esignglobal/v1/envelope/create

Descrizione dell'interfaccia

Crea un envelope in stato bozza.

Parametri della richiesta

Nome del parametro		Tipo	Obbligatorio	Descrizione
subject		string	true	Oggetto dell'envelope, esempio: "Lettera di offerta"
remark		string	false	Note dell'envelope, limite di lunghezza 1000 caratteri
signerSettings		object	false	Operazioni consentite al firmatario
	allowTransfer	boolean	false	Se è consentito al firmatario trasferire l'envelope a un altro utente per la firma, valore predefinito false true- Consente ai firmatari nell'envelope il potere di trasferirlo ad altri; false- Non consente ai firmatari nell'envelope il potere di trasferirlo ad altri;
	allowModifyName	boolean	false	Se è consentito al firmatario modificare il nome, valido solo per le firme dei modelli, valore predefinito false true- Consente al firmatario di modificare il nome false-Non è consentito al firmatario modificare il nome
tspScope		array	false	Ambito TSP a livello di busta, valore predefinito false. Se specificato, durante l'aggiunta del firmatario, è necessario selezionare il TSP da utilizzare dal range specificato. I valori enumerati includono: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni、belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia、estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom、harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId、mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign、smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe、certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha。
expireAfterSeconds		long	false	Scadenza della busta: numero di secondi dopo i quali la busta scade Intervallo di scadenza: da 86.400 secondi (1 giorno) a 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 conformarsi al protocollo https/http

Esempio di richiesta

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Parametri di risposta

Nome del parametro

Tipo

Descrizione

envelopeId

string

ID della busta

envelopeStatus

int

Stato della busta

0-Creata (bozza)

1-In firma

2-Completato

3-Scaduto

5-Annullato

Esempio di risposta

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}