API Isi Kolom Formulir PDF
Isi bidang teks dan kotak centang AcroForm yang dapat diedit dengan nilai yang divalidasi.
Semantik endpoint dan tugas#
Kode operasi: fill_form
Mulai operasi ini dengan POST /v1/tasks dan kode alat yang ditampilkan di atas. Unggah dan lampirkan PDF sumber (atau gunakan titik akhir unggahan berskop tugas), lalu panggil POST /v1/tasks/{task_id}/process dengan pengaturan operasi.
Isi sebelumnya dokumen onboarding, aplikasi dan formulir bisnis rutin.
Input: Satu PDF dengan kolom AcroForm. 1–100 nama kolom yang tepat; nilai adalah string atau boolean.
Konfigurasi dan parameter tambahan#
| Pengaturan | Jenis | Perilaku |
|---|---|---|
| valueswajib | object | Petakan nama widget PDF ke string (teks) atau boolean (kotak centang). Nama yang hilang dan jenis bidang yang tidak didukung gagal alih-alih berhasil diam-diam. |
Opsi divalidasi oleh API. Pengaturan yang tidak dikenal dan nilai yang tidak didukung mengembalikan kesalahan alih-alih diabaikan.
Urutan permintaan yang sedang berjalan#
Programming language: cURL
Pilih bahasa · gulir secara horizontal untuk semua 10 bahasa SDK
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"tool":"fill_form"}'
# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'
# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"options":{"values":{"FullName":"Jane Doe","AgreeToTerms":true}}}'
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_API_KEY'After starting a task, upload and verify PDFs, review the credit quote, and get explicit approval before processing. API keys belong on your server, never on signed storage uploads.
Paket yang dapat diunduh yang dihasilkan mencakup alur kerja tugas saja. SDK layanan penuh memerlukan spesifikasi OpenAPI runtime yang terverifikasi; SDK tugas Python, JavaScript, dan TypeScript melakukan streaming unggahan file; bahasa lain memerlukan unggahan multipart yang ditandatangani yang diimplementasikan oleh pemanggil.
ID tugas yang dikembalikan digunakan untuk polling status dan pengambilan. Setelah tugas berhasil, minta URL output yang ditandatangani daripada menyematkan rahasia unduhan.
Output dan detail penting#
PDF yang dapat diedit baru dengan nilai widget diisi dan tampilan diperbarui.
Formulir XFA, bidang tanda tangan, dan jenis widget yang tidak didukung ditolak. Hasil tidak diratakan atau ditandatangani secara digital. Tanda tangan PDF yang ada ditolak.
Kesalahan, percobaan ulang, dan penagihan