API untuk developer · Diperbarui
Hadirkan penandatanganan di dalam produk Anda sendiri.
Buat dokumen dari PDF, file Word, atau templat, kirim untuk ditandatangani, pantau statusnya, dan terima webhook saat sudah ditandatangani, semuanya dari kode Anda.
REST API
Webhook
Kunci API
Apakah API eSignSimple sudah tersedia?
Perangkat lunak Anda kini bisa membuat dokumen, mengirimnya untuk ditandatangani, memantau statusnya, dan mengunduh salinan yang sudah ditandatangani tanpa ada yang perlu masuk ke dasbor. REST API tersedia di https://esignsimple.com/api/v1, dan referensi lengkapnya beserta contoh permintaan dan respons ada di halaman developer kami.
Penanda tangan yang dijangkau lewat API mendapat pengalaman tanda tangan tanpa akun yang persis sama dan bukti yang sama seperti dokumen yang dikirim dari dasbor: jejak audit, sertifikat penyelesaian, dan hash SHA-256 yang bisa diperiksa siapa saja di halaman verifikasi publik kami.
Bagaimana API ini bekerja?
Buat dokumen dengan POST /documents. Anda mengirim permintaan multipart berisi PDF dan bagian JSON yang mencantumkan penanda tangan dan kolom, dengan posisi kolom dinyatakan sebagai pecahan dari halaman, sehingga Anda tidak perlu memikirkan satuan point PDF atau ukuran halaman. Dokumen langsung dikirim, atau disimpan sebagai draf jika Anda menyertakan send:false.
Sudah punya templat di dasbor? POST /templates/{id}/send mengisi penanda tangan dan mengirimnya. GET /documents menampilkan daftar dokumen Anda dengan filter status dan paginasi kursor melalui before. GET /documents/{id} mengembalikan status, penanda tangan, dan jejak audit lengkap, dan GET /documents/{id}/download mengembalikan PDF yang sudah ditandatangani setelah dokumen selesai, atau file aslinya dengan ?file=original.
Anda juga bisa membatalkan dokumen yang sedang berjalan dengan POST /documents/{id}/void, menghapus dokumen dengan DELETE /documents/{id}, dan memeriksa paket serta pemakaian Anda saat ini dengan GET /me.
Bagaimana autentikasi dan kunci API bekerja?
Setiap permintaan memakai kunci API Bearer. Anda membuat dan mencabut kunci di Pengaturan → Developer. Kunci hanya ditampilkan sekali saat dibuat dan kami hanya menyimpan hash-nya, jadi segera salin ke pengelola rahasia Anda. Jika kunci bocor, cabut lalu buat yang baru; tidak ada hal lain yang perlu diubah.
API yang sama juga menerima token ID Firebase, yang akan dipakai aplikasi seluler kami yang akan datang. Itu pilihan yang disengaja: kami membangun aplikasi kami sendiri di atas API publik yang sama dengan yang Anda pakai, sehingga API ini teruji setiap hari.
Webhook apa saja yang bisa Anda terima?
Alih-alih polling, daftarkan satu endpoint HTTPS untuk akun Anda dan kami akan memberi tahu endpoint itu saat sesuatu terjadi. Event yang tersedia adalah document.completed, document.declined, document.voided, dan signer.signed.
Setiap pengiriman ditandatangani dengan HMAC-SHA256 dan tanda tangannya dikirim di header esign-signature, sehingga Anda bisa memastikan permintaan itu benar-benar dari kami sebelum menindaklanjutinya. Jika endpoint Anda gagal, kami mencoba ulang sekali. Saran kami: perlakukan webhook sebagai pemicu dan panggil GET /documents/{id} untuk status yang otoritatif.
Apa yang dibangun orang dengan API ini?
CRM atau alat penawaran harga yang mengirim kontrak begitu kesepakatan ditandai menang. Sistem HR yang mengirim paket orientasi dari templat saat perekrutan dikonfirmasi. Alat manajemen properti yang mengirim perjanjian sewa dan mengarsipkan PDF yang sudah ditandatangani ke unit terkait saat document.completed tiba. Skrip internal yang menghentikan kebiasaan menyalin baris dari spreadsheet ke kontrak secara manual.
Jika Anda hanya mengirim beberapa dokumen per minggu, kemungkinan besar Anda sama sekali tidak memerlukan API. Templat, kirim massal, dan formulir web di dasbor sudah mencukupi dengan usaha yang jauh lebih sedikit.
Berapa harga API ini?
Tidak ada paket API terpisah. Batas paket yang berlaku sama seperti di aplikasi web: paket Free mencakup 5 dokumen per bulan dan Personal tidak terbatas (lihat harga). Dokumen yang dibuat lewat API dihitung persis seperti dokumen yang dikirim dari dasbor.
Penyedia besar seperti DocuSign, Dropbox Sign, dan Adobe biasanya menetapkan harga API terpisah dari paket pengguna, sering berdasarkan volume amplop tahunan, dan paket API tingkat awal bisa jauh lebih mahal daripada langganan standar mereka. Periksa situs web mereka untuk harga terkini.
Apa yang belum tersedia?
Kami terbuka soal kekurangannya. Belum ada iframe penandatanganan tertanam, jadi penanda tangan masih menandatangani melalui tautan yang kami kirim lewat email. Belum ada SDK resmi; API ini berbasis HTTP dan JSON biasa, jadi bahasa pemrograman apa pun yang punya klien HTTP bisa dipakai. Belum ada lingkungan sandbox terpisah, jadi lakukan pengujian dengan akun gratis dan alamat email Anda sendiri. Semua ini ada dalam rencana pengembangan kami.
Mengapa kami memulai dengan API yang kecil?
Kami sengaja memulai dari cakupan sempit. API kecil yang menjalankan alur kerja umum dengan baik, dengan batas yang bisa diprediksi dan tanpa harus menghubungi tim sales, lebih berguna daripada cakupan raksasa yang butuh berminggu-minggu untuk diintegrasikan. Jika ada yang Anda butuhkan tetapi belum ada, ceritakan apa yang sedang Anda bangun; integrasi nyata yang menentukan apa yang kami tambahkan berikutnya.
Endpoint API apa saja yang tersedia saat ini?
| Endpoint | Fungsinya | Penggunaan umum |
|---|---|---|
| POST /documents | Unggah PDF beserta penanda tangan dan kolom, kirim atau simpan sebagai draf | Mengirim kontrak yang dihasilkan aplikasi Anda |
| POST /templates/{id}/send | Kirim templat dasbor ke penanda tangan yang ditentukan | Paket orientasi saat perekrutan dikonfirmasi |
| GET /documents dan GET /documents/{id} | Daftar dokumen atau baca status, penanda tangan, dan jejak audit | Menyinkronkan status ke CRM |
| GET /documents/{id}/download | Unduh PDF yang sudah ditandatangani (atau file aslinya) | Mengarsipkan salinan bertanda tangan ke sebuah catatan |
| POST /documents/{id}/void dan DELETE /documents/{id} | Batalkan atau hapus dokumen | Menarik penawaran atau membersihkan draf |
| GET /me | Paket dan pemakaian bulan ini | Memberi peringatan sebelum mencapai batas Free |
Pertanyaan umum
Apakah eSignSimple punya API?
Ya. REST API sudah tersedia di https://esignsimple.com/api/v1 dengan kunci API Bearer dan webhook. Referensinya ada di halaman developer kami.
Berapa biaya API-nya?
Tidak ada harga API terpisah. Paket biasa Anda yang berlaku: Free mencakup 5 dokumen per bulan, Personal tidak terbatas.
Bagaimana cara mendapatkan kunci API?
Buat di Pengaturan → Developer. Kunci hanya ditampilkan sekali dan disimpan dalam bentuk hash, jadi segera simpan. Anda bisa mencabut kunci kapan saja.
Event webhook apa saja yang tersedia?
document.completed, document.declined, document.voided, dan signer.signed, ditandatangani dengan HMAC-SHA256 di header esign-signature, dengan satu kali percobaan ulang.
Apakah Anda mendukung penandatanganan tertanam, SDK, atau sandbox?
Belum. Ketiganya ada dalam rencana pengembangan kami. Saat ini penanda tangan menandatangani lewat tautan yang dikirim melalui email, dan Anda memanggil API melalui HTTP biasa.
Bacaan terkait
Dapatkan tanda tangan untuk dokumen Anda berikutnya hari ini.
Mulai dengan 5 dokumen gratis per bulan. Tanpa kartu kredit.