Dokumen ini bertujuan untuk memberikan penerangan mengenai Scope (domain kebenaran) dalam sistem pengesahan aplikasi eSignGlobal kepada pembangun rakan kongsi ekosistem. Pembangun perlu memohon Scope yang berkenaan semasa menyambungkan pengesahan aplikasi berdasarkan keperluan fungsi perniagaan sebenar. Setiap Scope mengandungi senarai OpenAPI yang dibenarkan dipanggil di bawah domain kebenaran tersebut, dan platform akan mengawal ketat kuasa operasi aplikasi terhadap sumber berkaitan berdasarkan Scope yang diluluskan.
API Pengesahan Asas
Sebelum aplikasi ekosistem memanggil API secara rasmi, ia perlu terlebih dahulu mendapatkan kredensial panggilan melalui titik akhir pengesahan:
Nama API
Laluan API
Penerangan API
Dapatkan AccessToken
POST /esignglobal/v1/oauth2/accessToken
Melalui appid dan appsecret untuk mendapatkan access_token pengesahan, digunakan untuk membuat permintaan ke eSignGlobal API sebagai pengguna tertentu, masa sah laku Token ialah 24 jam.
Domain kebenaran Scope yang dibuka dalam ekosistem eSignGlobal pada masa ini terutamanya termasuk:
signature: Perkhidmatan Teras Tandatangan Elektronik
Scope ini merupakan domain kebenaran asas dan paling kerap digunakan, yang merangkumi antara muka rantai penuh teras bagi perniagaan tandatangan elektronik. Selepas Scope ini diluluskan, aplikasi boleh mengurus dan melaksanakan operasi aliran pada templat, fail tandatangan (termasuk lampiran), pihak terlibat, serta aliran proses sampul surat utama.
Modul Satu: Perkhidmatan Templat
Nama Antara Muka
Penerangan Antara Muka
Dapatkan butiran kawalan templat penandatangan
Dapatkan maklumat kawalan templat bagi penandatangan tertentu dan konfigurasi atribut yang berkaitan
Dapatkan butiran templat
Dapatkan maklumat lengkap templat tertentu, termasuk butiran medan dan struktur fail
Isi templat untuk menjana fail
Mengisi data perniagaan berdasarkan templat yang diberikan dan secara automatik menggabungkan fail dalam format PDF
Cari senarai templat
Cari senarai templat yang tersedia di bawah akaun semasa secara berhalaman atau mengikut kriteria penapisan tertentu
Cari butiran tugas penggabungan fail
Query hasil pelaksanaan akhir tugas fail yang dijana oleh templat melalui ID tugasan asinkron
Modul Dua: Pengurusan Fail
Nama Antara Muka
Penerangan Antara Muka
Muat Naik Fail
Memuat naik fail tempatan atau fail aliran perniagaan yang ditentukan ke platform untuk tujuan penandatanganan seterusnya
Dapatkan koordinat berdasarkan kata kunci
Melakukan carian teks pada dokumen yang telah dimuat naik dan mengembalikan maklumat koordinat kedudukan bagi kata kunci yang sepadan
Muat Turun Fail
Memuat turun dokumen tandatangan lengkap tertentu, fail sumber, atau fail lampiran perniagaan lain
Tambah Fail Tandatangan
Mengikat fail yang berjaya dimuat naik sebelumnya ke dalam sampul atau aliran kerja tandatangan yang spesifik
Padam Fail Tandatangan
Menyingkirkan fail yang salah muat naik atau sementara tidak diperlukan untuk penandatatangan daripada aliran kerja sampul
Tambah Lampiran
Tambah lampiran penerangan bersifat tambahan dalam proses sampul atau penandatanganan
Padam lampiran
Buang dokumen lampiran yang ditetapkan daripada proses sampul atau penandatanganan
Modul Tiga: Pengurusan Penyerta
Nama Antara Muka
Penerangan Antara Muka
Tambah Penandatangan
Tambah penyerta penandatanganan yang perlu melaksanakan tindakan tandatangan dalam proses sampul tertentu
Padam Penandatangan
Buang pihak penandatanganan yang telah dibatalkan dalam proses sampul tertentu
Tambah Penerima Salinan
Tambah peranan penerima salinan, hanya menerima pemberitahuan kemajuan dan melihat dokumen tandatangan akhir yang siap
Padam Penerima Salinan
Buang peranan penerima salinan tertentu
Modul Empat: Pengurusan Sampul
Nama API
Penerangan API
Mulakan Sampul Surat dengan Pantas
Jika platform yang disambungkan menggunakan API ini untuk mencipta sampul surat, dan selepas penandatanganan selesai, sistem akan memproses aliran kerja penamatan secara automatik tanpa memerlukan panggilan manual kepada 'Tamatkan Sampul Surat'.
Cipta Sampul Surat
Digunakan untuk mencipta sampul surat dalam status draf, menyokong konfigurasi parameter seperti topik penandatanganan, tetapan penandatangan, dan lain-lain.
Buka Sampul Surat
Selepas mengesahkan semua dokumen dan penandatangan adalah tepat, tugasan penandatanganan akan dihantar secara rasmi kepada proses seterusnya.
Tamatkan Sampul Surat
Tamatkan sampul surat secara manual. Sebelum sampul surat ditamatkan, semua penandatangan mesti menyelesaikan penandatanganan, dan sumber tidak boleh diubah selepas aliran kerja selesai.
Dapatkan Alamat Penandatanganan
Dapatkan pautan pendek eksklusif atau URL halaman penandatanganan yang boleh dimuat terus bagi penandatangan tertentu.
Semak Butiran Sampul Surat
Dapatkan maklumat keseluruhan sampul surat tersebut, fail berkaitan, peserta, serta status aliran semasa.
Batalkan Sampul Surat
Pihak pengirim menarik balik secara proaktif satu sampul tandatangan yang belum diselesaikan sepenuhnya
Sampul notis pengingat
Apabila tandatangan sampul belum lengkap, sistem menyokong penghantaran notis pengingat kepada penandatangan yang belum menandatangani, dengan selang masa pengingat sebanyak 30 minit.
Dapatkan alamat halaman pratinjau tandatangan
Selepas sampul diaktifkan, alamat halaman pratinjau tandatangan boleh diperoleh melalui API ini. Ia terutamanya digunakan untuk membolehkan bukan peserta sampul melihat dokumen dan kemajuan tandatangan dalam platform integrasi.
Cipta paparan penghantaran sampul
Cipta paparan pengirim sampul berdasarkan ID Sampul. Untuk aliran tandatangan yang dimulakan di bawah paparan ini, maklumat pihak pengirim akan diisi dengan maklumat pengguna yang diterbitkan daripada Access Token OAuth.
2.2 Scope: stamp (Perkhidmatan Pengurusan Cap)
Scope ini khusus untuk pentauliahan pengurusan cap korporat atau cap nama peribadi. Ia sesuai untuk ekosistem pihak ketiga yang hanya memerlukan penyelenggaraan pangkalan cap korporat yang bersatu (tambah, buang, ubah dan cari cap), tanpa perlu campur tangan secara langsung dalam aliran proses tandatangan.
Nama API
Penerangan API
Cari Senarai Cap
Gunakan AppID yang mempunyai kebenaran untuk mencari cap berkaitan bagi mendapatkan data senarai sumber cap.
Cipta Cap
Gunakan AppID yang mempunyai kebenaran untuk mencipta cap menggunakan rentetan kod Base64 imej yang dimuat naik (menyokong PNG, saiz 18mm hingga 100mm).
Sunting Cap
Ubah suai maklumat seperti nama dan imej bagi cap yang telah dicipta
Padam Cap
Alih keluar sepenuhnya sumber cap yang ditentukan dan tidak lagi mempunyai kaitan perniagaan
Scope ini khusus untuk domain fungsi undang-undang kontrak pintar. Ia membolehkan aplikasi rakan kongsi ekosistem menggunakan keupayaan perbandingan teks dan versi secara fleksibel dalam proses semakan kontrak dan penilaian undang-undang mereka, bagi memantau perbezaan sebelum dan selepas pengubahsuaian kontrak dengan pantas.
Nama Antara Muka
Penerangan Antara Muka
Dapatkan Halaman Keputusan Perbandingan Kontrak
Dapatkan alamat halaman visualisasi yang memaparkan hasil perbezaan perbandingan
Semak Butiran Perbandingan Kontrak
Dapatkan hasil perbandingan kontrak melalui ID perniagaan perbandingan kontrak, yang merangkumi bilangan perbezaan (penambahan, pemadaman, pengubahsuaian) serta kandungan perbezaan perbandingan yang terperinci (lokasi butiran).
