Penjelasan Ruang Lingkup Antarmuka Aplikasi Ekosistem ISV

1. Ringkasan

Dokumen ini bertujuan untuk memberikan penjelasan mengenai Scope (domain izin) dalam sistem otorisasi aplikasi eSignGlobal bagi pengembang mitra ekosistem. Saat melakukan integrasi otorisasi aplikasi, pengembang perlu mengajukan Scope yang sesuai berdasarkan kebutuhan fungsi bisnis aktual. Setiap Scope mencakup daftar OpenAPI yang diizinkan untuk dipanggil di bawah domain izin tersebut, dan platform akan secara ketat mengontrol hak akses aplikasi terhadap sumber daya terkait berdasarkan Scope yang diotorisasi.

Antarmuka Autentikasi Dasar

Sebelum aplikasi ekosistem memanggil antarmuka secara resmi, Anda harus terlebih dahulu mendapatkan kredensial panggilan melalui endpoint otorisasi:

Nama Antarmuka	Jalur Antarmuka	Deskripsi Antarmuka
Dapatkan AccessToken	`POST /esignglobal/v1/oauth2/accessToken`	Melalui appid dan appsecret untuk mendapatkan access_token autentikasi, yang digunakan untuk mengakses API eSignGlobal sebagai pengguna tertentu, dengan masa berlaku token selama 24 jam.

Saat ini, domain izin Scope yang dibuka oleh ekosistem eSignGlobal terutama meliputi:

signature: Layanan Inti Tanda Tangan Elektronik
stamp: Layanan Manajemen Stempel
comparisons: Layanan Perbandingan Kontrak

2. Rincian Scope dan Daftar Antarmuka

2.1 Scope: `signature` (Layanan Tanda Tangan Elektronik)

Scope ini merupakan domain otorisasi paling dasar dan sering digunakan, yang mencakup seluruh antarmuka inti dalam rantai proses bisnis tanda tangan elektronik. Setelah memberikan otorisasi pada Scope ini, aplikasi dapat mengelola dan menjalankan operasi alur kerja amplop utama, serta template, dokumen penandatanganan (termasuk lampiran), dan para pihak yang terlibat.

Modul 1: Layanan Template

Nama Antarmuka	Deskripsi Antarmuka
Dapatkan detail kontrol template penandatangan	Dapatkan informasi kontrol template penandatangan tertentu beserta konfigurasi atribut yang sesuai
Dapatkan detail template	Dapatkan informasi lengkap template tertentu, termasuk detail bidang dan struktur file
Isi template untuk menghasilkan file	Berdasarkan template yang diberikan, isi data bisnis dan otomatis gabungkan menjadi file berformat PDF
Kueri daftar template	Kueri daftar template yang tersedia di bawah akun saat ini secara berpindah halaman atau berdasarkan kondisi filter tertentu
Kueri detail tugas penggabungan file	Memeriksa hasil eksekusi akhir tugas pembuatan file dari templat melalui ID tugas asinkron

Modul Dua: Manajemen File

Nama Antarmuka	Deskripsi Antarmuka
Unggah File	Mengunggah file lokal atau file alur bisnis tertentu ke platform untuk keperluan penandatanganan selanjutnya
Dapatkan koordinat berdasarkan kata kunci	Melakukan pencarian teks pada dokumen yang telah diunggah dan mengembalikan informasi koordinat lokasi kata kunci yang sesuai
Unduh File	Mengunduh dokumen yang telah selesai ditandatangani, file sumber, atau file lampiran bisnis lainnya secara spesifik
Tambahkan File Penandatanganan	Mengaitkan file yang berhasil diunggah sebelumnya ke dalam amplop atau alur kerja penandatanganan tertentu
Hapus File Penandatanganan	Menghapus file yang salah diunggah atau sementara tidak diperlukan untuk penandatanganan dari alur kerja amplop
Tambahkan Lampiran	Tambahkan lampiran penjelasan tambahan ke dalam proses amplop atau penandatanganan
Hapus lampiran	Hapus dokumen lampiran tertentu dari proses amplop atau penandatanganan

Modul 3: Manajemen Pihak

Nama Antarmuka	Deskripsi Antarmuka
Tambah Penandatangan	Tambahkan pihak penandatangan yang perlu melakukan tindakan penandatanganan pada proses amplop tertentu
Hapus Penandatangan	Hapus pihak penandatangan yang sudah tidak aktif pada proses amplop tertentu
Tambah Penerima Salinan	Tambahkan peran penerima salinan, hanya menerima notifikasi kemajuan dan melihat dokumen akhir yang telah selesai ditandatangani
Hapus Penerima Salinan	Hapus peran penerima salinan tertentu

Modul 4: Manajemen Amplop

Nama API	Deskripsi API
Inisiasi Amplop Cepat	Jika platform yang terintegrasi menggunakan API ini untuk membuat amplop dan setelah penandatanganan selesai, sistem akan secara otomatis memproses alur penyelesaian, sehingga tidak perlu lagi memanggil 'Akhiri Amplop' secara manual.
Buat Amplop	Digunakan untuk membuat amplop dalam status draf, mendukung konfigurasi parameter seperti subjek penandatanganan, pengaturan penandatangan, dan lainnya.
Aktifkan Amplop	Setelah memastikan semua dokumen dan penandatangan sudah benar, tugas penandatanganan secara resmi dikirim ke tahap berikutnya.
Akhiri Amplop	Akhiri amplop secara manual. Sebelum amplop diakhiri, semua penandatangan harus menyelesaikan penandatanganan, dan sumber daya tidak dapat diubah setelah proses selesai.
Dapatkan Alamat Penandatanganan	Dapatkan tautan pendek khusus atau URL halaman penandatanganan yang dapat dimuat langsung untuk penandatangan tertentu.
Periksa Detail Amplop	Dapatkan informasi lengkap amplop, file terkait, peserta, serta status alur kerja saat ini.
Batalkan Amplop	Pihak inisiator secara proaktif menarik kembali amplop penandatanganan yang belum diselesaikan sepenuhnya
Amplop Pengingat	Ketika amplop belum selesai ditandatangani, mendukung pengiriman pengingat kepada penandatangan yang belum menandatangani, dengan interval pengingat setiap 30 menit
Dapatkan alamat halaman pratinjau penandatanganan	Setelah amplop dibuka, alamat halaman pratinjau penandatanganan dapat diperoleh melalui antarmuka ini. Utamanya digunakan dalam platform terintegrasi untuk memungkinkan pihak di luar peserta amplop melihat dokumen dan kemajuan penandatanganan.
Buat tampilan pengiriman amplop	Buat tampilan pengirim amplop berdasarkan ID amplop. Alur penandatanganan yang dimulai dari tampilan ini akan mengisi informasi inisiator menggunakan data pengguna yang diparsing dari Access Token OAuth.

2.2 Scope: `stamp` (Layanan Manajemen Cap)

Scope ini khusus ditujukan untuk otorisasi manajemen cap perusahaan atau cap nama pribadi. Cocok untuk ekosistem pihak ketiga yang hanya memerlukan pemeliharaan basis data cap perusahaan terpadu (penambahan, penghapusan, pembaruan, dan pencarian cap), tanpa perlu langsung mengintervensi alur inisiasi penandatanganan.

Nama Antarmuka	Deskripsi Antarmuka
Daftar Cap Pencarian	Gunakan AppID dengan hak akses query cap yang sesuai untuk mendapatkan data daftar sumber daya cap
Buat Cap	Gunakan AppID berwenang untuk membuat cap melalui string kode Base64 gambar yang diunggah (mendukung PNG, ukuran 18mm-100mm)
Edit Stempel	Memodifikasi informasi seperti nama dan gambar pada stempel yang telah dibuat
Hapus Stempel	Menghapus secara permanen sumber daya stempel tertentu yang tidak lagi memiliki keterkaitan bisnis

2.3 Scope: `comparisons` (Layanan Perbandingan Kontrak)

Scope ini dikhususkan untuk domain fungsi hukum kontrak cerdas. Memungkinkan aplikasi mitra ekosistem untuk secara fleksibel memanggil kemampuan perbandingan teks dan versi dalam tahap peninjauan kontrak dan evaluasi hukum mereka sendiri, agar dapat dengan cepat mengendalikan perbedaan sebelum dan sesudah revisi kontrak.

Nama Antarmuka	Deskripsi Antarmuka
Dapatkan Halaman Hasil Perbandingan Kontrak	Dapatkan Alamat Halaman Visualisasi yang Menampilkan Hasil Perbedaan Perbandingan
Cari Detail Perbandingan Kontrak	Dapatkan hasil perbandingan kontrak melalui ID bisnis perbandingan kontrak, yang mencakup jumlah perbedaan (jumlah tambah, hapus, ubah) serta konten perbedaan perbandingan yang terperinci (lokasi detail).