Membuat sampul

POST /esignglobal/v1/envelope/create

Penerangan Antara Muka

Mencipta sampul dalam keadaan draf.

Parameter Permintaan

Nama Parameter		Jenis	Wajib	Keterangan
subject		string	true	Tajuk sampul, contoh: "Surat Tawaran"
remark		string	false	Nota sampul, had panjang 1000 aksara
signerSettings		object	false	Tindakan yang dibenarkan kepada penandatangan
	allowTransfer	boolean	false	Adakah penandatangan dibenarkan menyerahkan sampul ini kepada orang lain untuk ditandatangani, lalai false true- Membenarkan penandatangan dalam sampul mempunyai kuasa untuk menyerahkan kepada orang lain; false- Tidak membenarkan penandatangan dalam sampul mempunyai kuasa untuk menyerahkan kepada orang lain;
	allowModifyName	boolean	false	Adakah penandatangan dibenarkan mengubah nama, hanya berkuat kuasa untuk tandatangan templat, lalai false true- Membenarkan penandatangan mengubah nama false-Penandatangan tidak dibenarkan mengubah nama
tspScope		array	false	Skop TSP tahap sampul, lalai false. Selepas ditetapkan, semasa menambah penandatangan, perlu memilih TSP yang akan digunakan oleh penandatangan daripada skop yang ditetapkan. Nilai enom termasuk: 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	Masa luput sampul: berapa saat selepas itu sampul menjadi luput Julat luput: 86,400 saat (1 hari) ~7,776,000 saat (90 hari).
redirectUrl		string	false	Alamat pengalihan selepas penandatanganan selesai (panjang 2048), mestilah alamat http yang sah
callBackUrl		string	false	Alamat panggilan balik (panjang 500), mestilah mengikut protokol alamat https/http

Contoh permintaan

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

Parameter respons

Nama parameter

Jenis

Keterangan

envelopeId

string

ID sampul

envelopeStatus

int

Status sampul

0-Dicipta (draf)

1-Dalam proses penandatanganan

2-Selesai

3-Tamat tempoh

5-Dibatalkan

Contoh respons

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