Buat Amplop

POST /esignglobal/v1/envelope/create

Deskripsi Antarmuka

Membuat amplop dalam status draf.

Parameter Permintaan

Nama Parameter		Jenis	Wajib Diisi	Keterangan
subject		string	true	Subjek amplop, contoh: "Surat Penawaran"
remark		string	false	Catatan amplop, batasan panjang 1000 karakter
signerSettings		object	false	Operasi yang diizinkan untuk penandatangan
	allowTransfer	boolean	false	Apakah penandatangan diizinkan untuk menyerahkan amplop ini kepada orang lain untuk ditandatangani, defaultnya false true- Mengizinkan penandatangan dalam amplop untuk memiliki hak untuk menyerahkan amplop kepada orang lain; false- Tidak mengizinkan penandatangan dalam amplop untuk memiliki hak untuk menyerahkan amplop kepada orang lain;
	allowModifyName	boolean	false	Apakah pihak penandatangan diizinkan untuk mengubah nama, hanya berlaku untuk tanda tangan templat, defaultnya false true- Mengizinkan penandatangan untuk mengubah nama false-Penandatangan tidak diizinkan mengubah nama
expireAfterSeconds		long	false	Waktu kedaluwarsa amplop: Amplop akan kedaluwarsa setelah berapa detik Rentang kedaluwarsa: 86.400 detik (1 hari) ~ 7.776.000 detik (90 hari).
redirectUrl		string	false	Alamat pengalihan setelah penandatanganan selesai (panjang 2048), harus berupa alamat http yang valid
callBackUrl		string	false	Alamat panggilan balik (panjang 500), harus sesuai dengan alamat protokol https /http

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 amplop

envelopeStatus

int

Status amplop

0-Dibuat (draf)

1-Sedang ditandatangani

2-Selesai

3-Kedaluwarsa

5-Dibatalkan

Contoh Respons

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