Cipta Sampul Surat

POST /esignglobal/v1/envelope/create

Deskripsi Antara Muka

Cipta sampul surat dalam status draf.

Parameter Permintaan

Nama Parameter		Jenis	Adakah Wajib	Keterangan
subject		string	true	Tajuk sampul surat, contoh: “Surat Tawaran”
remark		string	false	Nota sampul surat, had panjang 1000 aksara
signerSettings		object	false	Operasi yang dibenarkan untuk penandatangan
	allowTransfer	boolean	false	Adakah penandatangan dibenarkan untuk memindahkan sampul surat ini kepada orang lain untuk ditandatangani, lalai adalah palsu true-Benarkan penandatangan dalam sampul surat mempunyai kuasa untuk memindahkan sampul surat kepada orang lain; false-Tidak membenarkan penandatangan dalam sampul surat mempunyai kuasa untuk memindahkan sampul surat kepada orang lain;
	allowModifyName	boolean	false	Adakah pihak yang menandatangani dibenarkan untuk mengubah suai nama, hanya berkuat kuasa untuk tandatangan templat, lalai adalah palsu true-Benarkan penandatangan mengubah suai nama false-Pihak yang menandatangani tidak dibenarkan mengubah nama
expireAfterSeconds		long	false	Masa tamat tempoh sampul surat: Sampul surat akan tamat tempoh selepas berapa saat Julat tamat tempoh: 86,400 saat (1 hari) ~ 7,776,000 saat (90 hari).
redirectUrl		string	false	Alamat pengalihan selepas menandatangani selesai (panjang 2048), mestilah alamat http yang sah
callBackUrl		string	false	Alamat panggilan balik (panjang 500), mestilah alamat protokol https /http yang sah

Contoh permintaan

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Parameter respons

Nama parameter

Jenis

Keterangan

envelopeId

string

ID Sampul Surat

envelopeStatus

int

Status Sampul Surat

0-Dicipta (draf)

1-Sedang ditandatangani

2-Selesai

3-Telah Tamat Tempoh

5-Telah Dibatalkan

Contoh Respons

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