Ratakan PDF Forms dan Annotations API
Bake bidang formulir dan anotasi yang didukung ke dalam tampilan halaman permanen.
Semantik endpoint dan tugas#
Kode operasi: flatten
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.
Bagikan formulir terisi yang telah ditinjau tanpa membiarkan bidang interaktif atau komentar dapat diedit.
Input: Satu PDF, maksimal 100 MiB dan 500 halaman; batas akun yang lebih rendah dapat berlaku.
Konfigurasi dan parameter tambahan#
Operasi ini tidak memerlukan opsi tambahan. Kirimkan objek opsi kosong.
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":"flatten"}'
# 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":{}}'
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 baru dengan anotasi yang didukung dan kolom formulir tertanam sebagai konten non-interaktif.
Perataan bukan redaksi atau sanitasi forensik. PDF yang ditandatangani dan formulir XFA ditolak; periksa kesetiaan pada tampilan formulir kompleks.
Kesalahan, percobaan ulang, dan penagihan