API dan webhook
Mengunggah dan membaca dokumen tersedia melalui REST API. Pengelolaan akun, folder, label, dan koneksi tetap dilakukan di dalam aplikasi.
Kunci
Dibuat di Pengaturan → Untuk Pengembang. Kunci akan ditampilkan sekali, saat dibuat — setelah itu tidak akan ditampilkan lagi, karena hanya sidik jarinya yang disimpan. Kunci yang hilang tidak dapat dipulihkan, kunci baru harus dibuat dan yang lama dihapus. Anda dapat memiliki lima kunci, masing-masing dengan masa berlaku opsional hingga dua tahun.
Pemilik akun akan mendapatkan email untuk setiap kunci baru, serta dua minggu sebelum kunci kedaluwarsa. Lihat Pemberitahuan melalui email.
Kunci dikirim dalam header X-API-Key.
Apa yang dapat dilakukan API
| Operasi | Deskripsi |
|---|---|
POST /api/upload | Mengunggah file dengan opsi: format, arah, jenis, mata uang, skema, folder, webhook |
POST /api/upload/url | Sama seperti di atas dari alamat publik; kami akan mengunduh file sendiri |
GET /api/jobs | Daftar dokumen dengan filter dan pagination |
GET /api/jobs/{id} | Status, data yang dibaca, temuan, dan hasil dalam format target |
GET /api/jobs/{id}/original | File yang diunggah |
DELETE /api/jobs/{id} | Penghapusan ke tempat sampah |
Excel dan PDF dikirim dalam hasil sebagai Base64. Jika tidak memerlukan hasil, kirimkan
includeResult=false, untuk menghemat konversi di server.
Deskripsi antarmuka dalam format OpenAPI dapat ditemukan di alamat /api/docs; tautan ada di pengaturan
pada kunci. Deskripsi dihasilkan dari kode yang sedang berjalan, sehingga sesuai dengan apa yang dilakukan API.
Pemeriksaan untuk dokumen dari API
Pemeriksaan sebelum pengiriman berlaku secara default juga untuk dokumen yang diunggah dengan kunci: dokumen menunggu konfirmasi dalam aplikasi dan webhook akan dikirim setelahnya. Bagi yang membangun integrasi di mana tidak ada orang yang duduk di depan layar, dapat menghapus saluran API di Pengaturan → Pemeriksaan sebelum pengiriman, atau mematikan pemeriksaan.
MCP
Untuk agen AI, ada server MCP di alamat /api/mcp dengan kunci yang sama. Dapat membaca
dan mencari dokumen, tidak bisa mengunggah; pengunggahan akan dikembalikan sebagai perintah siap yang akan dieksekusi oleh agen itu sendiri.
Webhook
Alih-alih menanyakan status, biarkan hasil dikirim saat sudah siap. Alamat diatur untuk seluruh akun di Pengaturan → Untuk Pengembang, atau untuk unggahan individu dengan parameter targetWebhookUrl. Tombol di pengaturan akan mengirimkan pesan uji.
Sebuah POST dengan JSON akan dikirim: pengidentifikasi dokumen, nama file, format, dan hasil
dalam format target. Ketika dokumen melewati pemeriksaan atau diproses lagi, webhook akan dikirimkan kedua kali dengan tanda perbaikan (IsCorrection).
Pesan tidak ditandatangani. Verifikasi pengirim dengan menambahkan kunci rahasia Anda ke alamat. Alamat ke jaringan pribadi akan ditolak.
Ketika webhook tidak berhasil setelah semua upaya, sekitar empat setengah jam, sebuah email akan dikirim. Selama satu gangguan hanya sekali, kegagalan selanjutnya akan tercatat dalam aktivitas. Email juga akan dikirim setelah setiap perubahan alamat webhook, jika ada yang mengubahnya selain Anda.
Pengiriman yang gagal akan diulang dengan penundaan yang meningkat, sebelas upaya selama sekitar empat setengah jam. Setiap usaha dicatat dalam aktivitas beserta respons dari pihak Anda; pada dokumen dalam daftar ada ikon dengan hasil pengiriman.
Batasan
API tidak memiliki batasan sendiri pada jumlah panggilan per menit; pengunggahan dibatasi oleh kredit, ukuran file sesuai tarif, dan dua puluh halaman per dokumen. Penolakan akan datang sebagai kesalahan 400 dengan kode yang menjelaskan alasannya. Server MCP terbatas pada sepuluh permintaan per detik.