Tambahkan fail tandatangan

POST /esignglobal/v1/envelope/files/addSignFiles

Penerangan Antara Muka

Apabila sampul surat belum dibuka, sokongan untuk menambah fail yang perlu ditandatangani ke dalam sampul surat disediakan. Sampul surat yang telah dibuka tidak menyokong penambahan fail tandatangan.

Parameter Permintaan

Nama Parameter			Jenis	Wajib	Keterangan
envelopeId			string	true	ID Sampul Surat
signFiles			array	true	Maklumat fail tandatangan, susunan papar mengikut urutan penambahan fail.
	fileKey		string	true	fileKey fail tandatangan, hanya menyokong format PDF
	documentFields		array	false	Senarai kawalan dimensi fail. Digunakan untuk menambah kawalan dimensi fail pada fail tertentu tanpa mengikat penandatangan.
		fieldType	string	false	Jenis kawalan. Masukkan eMeterai untuk menunjukkan kawalan cukai meterai Indonesia.
		pageNo	string	false	Nombor halaman tempat kawalan berada. Kawalan cukai meterai Indonesia hanya menyokong penetapan halaman tunggal, jadi nombor halaman tunggal perlu dimasukkan. Format berbilang halaman berterusan atau tidak berterusan seperti 1-3 atau 1,3 tidak disokong.
		posX	float	false	Anjakan paksi-x, titik asal koordinat adalah di sudut kiri bawah halaman. Julat koordinat adalah sama dengan julat koordinat kawalan lain.
		posY	float	false	Anjakan paksi-y, titik asal koordinat adalah di sudut kiri bawah halaman. Julat koordinat adalah sama dengan julat koordinat kawalan lain.

Contoh permintaan

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

Parameter respons

Nama parameter	Jenis	Penerangan
code	int	Kod perniagaan, 0 menunjukkan kejayaan, bukan 0 menunjukkan ralat.
message	string	Maklumat perniagaan [Perhatian] Sila tentukan keadaan ralat berdasarkan code, jangan bergantung pada padanan message kerana message mungkin diubah suai.
data	object	Data perniagaan

Contoh respons

{
    "code": "0",
    "message": "success",
    "data": null
}