Pusat pembangun

Cipta paparan penghantaran sampul surat

POST /esignglobal/v1/envelopes/views/sender

Deskripsi Antara Muka

Mencipta paparan penghantar sampul surat melalui id sampul surat, pembangun boleh mengintegrasikan paparan penghantar yang diperoleh melalui antara muka ini ke dalam aplikasi pihak ketiga mereka sendiri

  1. Proses tandatangan yang dimulakan melalui halaman permulaan tandatangan yang diperoleh melalui paparan ini, pihak pemula diisi dengan maklumat pengguna yang diuraikan daripada Token Akses dalam oauth
  2. Sebelum memanggil antara muka ini, anda perlu mencipta sampul surat dalam status draf melalui antara muka mencipta proses tandatangan
  3. Selepas mencipta id proses tandatangan, anda dibenarkan untuk menetapkan sampul surat melalui antara muka seperti menambah fail tandatangan dan menambah pihak yang menandatangani
  4. Halaman permulaan yang dijana oleh paparan ini menyokong pembenaman iframe dan webview, dan bahasa halaman lalai ialah Bahasa Inggeris
  5. Memanggil antara muka ini tidak menyokong proses tandatangan yang termasuk tandatangan senyap penandatangan

Parameter Permintaan

Nama Parameter

Jenis

Adakah Wajib

Keterangan

envelopeId

string

true

ID proses tandatangan, hanya ID proses tandatangan 0-dicipta (draf) dibenarkan untuk dimasukkan

returnUrl

string

true

Alamat ubah hala selepas proses penghantaran tandatangan selesai (panjang 2048), yang mesti mematuhi alamat protokol https /http

settingsobjectfalseTetapan tersuai halaman penghantaran
 startingPagestringfalseHantar halaman permulaan paparan, lalai ialah preparePage.
preparePage - halaman tetapan maklumat asas
taggingPage- halaman tetapan kawalan tandatangan
 submitActionstringfalseSerah, lalai ialah send
save-Simpan, halaman memaparkan butang simpan, menyembunyikan butang berkaitan hantar;
send-Hantar, halaman memaparkan butang hantar sekarang, hantar, hantar kemudian, menyembunyikan butang simpan;
 showBackButtonbooleanfalseSama ada untuk memaparkan butang Kembali Halaman Penandaan, lalai ialah benar.
true-Paparkan
false-Jangan paparkan
 

lockedArea

arrayfalse

Maklumat yang tidak dibenarkan untuk diubah suai dalam senderView, lalai adalah kosong. Nilai enum termasuk:

document - Fail tandatangan

signerInfo - Maklumat Penandatangan

Contoh Permintaan

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

Parameter Respons

Nama Parameter

Jenis

Penerangan

url

string

Alamat Halaman Mulakan Sampul Surat

Contoh Respons

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}

 

Deskripsi Antara Muka
Parameter Permintaan
Contoh Permintaan
Parameter Respons
Contoh Respons