API dan webhook
Pengunggahan dan pembacaan dokumen tersedia melalui REST API. Manajemen akun, folder, label, dan koneksi tetap dilakukan di aplikasi.
Kunci
Dibuat di Pengaturan → Untuk Pengembang. Kunci akan ditampilkan sekali, saat dibuat — setelah itu tidak lagi, karena hanya sidik jarinya yang disimpan. Kunci yang hilang tidak dapat diregenerasi, dibuat yang baru dan yang lama dihapus. Anda dapat memiliki lima kunci, masing-masing dengan masa berlaku opsional hingga dua tahun.
Kunci dikirim di header X-API-Key.
Apa yang bisa dilakukan API
| Operasi | Deskripsi |
|---|---|
POST /api/upload | Mengunggah file dengan opsi: format, arah, jenis, mata uang, skema, folder, webhook |
POST /api/upload/url | Hal yang sama dari alamat publik; file akan diunduh oleh kami |
GET /api/jobs | Daftar dokumen dengan filter dan paging |
GET /api/jobs/{id} | Status, data yang dibaca, temuan dan hasil dalam format tujuan |
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 hasil tidak diperlukan, kirim
includeResult=false, ini akan menghemat konversi di server.
Deskripsi antarmuka dalam format OpenAPI dapat ditemukan di /api/docs; tautan ada di pengaturan
di bagian kunci. Deskripsi dihasilkan dari kode yang berjalan, sehingga mencerminkan apa yang dilakukan API.
Pemeriksaan dokumen dari API
Pemeriksaan sebelum pengiriman berlaku secara default juga untuk dokumen yang diunggah dengan kunci: dokumen menunggu konfirmasi di aplikasi dan webhook akan dikirim setelahnya. Jika Anda membangun integrasi di mana tidak ada yang duduk di depan layar, Anda dapat di Pengaturan → Pemeriksaan sebelum pengiriman menghapus saluran API, atau mematikan pemeriksaan.
MCP
Untuk agen AI, di alamat /api/mcp server MCP dengan kunci yang sama. Dapat membaca
dan mencari dokumen, tidak bisa mengunggah; unggahan akan dikembalikan sebagai perintah selesai, yang akan dijalankan 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 setiap unggahan dengan parameter targetWebhookUrl. Tombol di pengaturan akan mengirim pesan pengujian.
Sebuah POST akan dikirim dengan JSON: identifikasi dokumen, nama file, format, dan hasil
dalam format tujuan. Ketika dokumen melewati pemeriksaan atau diproses ulang, webhook akan diterima
untuk kedua kalinya dengan tanda perbaikan (IsCorrection).
Pesan tidak memiliki tanda tangan. Verifikasi pengirim dengan menambahkan token rahasia Anda sendiri ke alamat. Alamat ke jaringan pribadi ditolak.
Pengiriman yang gagal akan diulang dengan jeda yang semakin meningkat, sebelas percobaan selama sekitar empat setengah jam. Setiap percobaan 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 dibatasi pada sepuluh permintaan per detik.