Membuat Amplop

POST /esignglobal/v1/envelope/create

Deskripsi Antarmuka

Membuat amplop dalam status draf.

Parameter Permintaan

Nama Parameter		Tipe	Wajib Diisi	Keterangan
subject		string	true	Subjek amplop, contoh: "Surat Penawaran"
remark		string	false	Catatan amplop, batas panjang 1000 karakter
signerSettings		object	false	Operasi yang diizinkan bagi penandatangan
	allowTransfer	boolean	false	Apakah penandatangan diperbolehkan untuk menyerahkan amplop kepada orang lain untuk ditandatangani, default false true- Mengizinkan penandatangan dalam amplop memiliki hak untuk menyerahkan amplop kepada orang lain; false- Tidak mengizinkan penandatangan dalam amplop memiliki hak untuk menyerahkan amplop kepada orang lain;
	allowModifyName	boolean	false	Apakah penandatangan diperbolehkan untuk mengubah nama, hanya berlaku untuk tanda tangan template, default false true- Mengizinkan penandatangan untuk mengubah nama false-Penandatangan tidak diizinkan mengubah nama
tspScope		array	false	Cakupan TSP tingkat amplop, default false. Setelah ditentukan, saat menambahkan penandatangan, perlu memilih TSP yang akan digunakan oleh penandatangan dari cakupan yang ditentukan. Nilai enumerasi meliputi: 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	Waktu kedaluwarsa amplop: berapa detik setelah itu amplop menjadi kedaluwarsa Rentang kedaluwarsa: 86.400 detik (1 hari) ~7.776.000 detik (90 hari).
redirectUrl		string	false	Alamat redirect setelah penandatanganan selesai (panjang 2048), harus berupa alamat http yang valid
callBackUrl		string	false	Alamat callback (panjang 500), harus sesuai dengan alamat protokol 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

Tipe

Keterangan

envelopeId

string

ID amplop

envelopeStatus

int

Status amplop

0-Dibuat (draf)

1-Dalam proses penandatanganan

2-Selesai

3-Kedaluwarsa

5-Dibatalkan

Contoh respons

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