Menambahkan Kolom Formulir ke PDF - API Formulir Interaktif
PDF4me Tambahkan Kolom Formulir ke PDF memungkinkan Anda menambahkan kolom formulir interaktif ke PDF dokumen. Ini API proses layanan PDF File tersebut menambahkan kolom formulir (kotak teks dan kotak centang) pada posisi tertentu di halaman yang ditentukan. API menerima PDF parameter konten dan kolom formulir melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk penempatan yang fleksibel, tipe bidang khusus, dan penargetan halaman, solusi ini ideal untuk otomatisasi dokumen dan interaktif. PDF alur kerja pengembangan.
Mengautentikasi Permintaan API Anda
Untuk mengakses PDF4me REST APISetiap permintaan harus menyertakan kredensial otentikasi yang tepat. Otentikasi memastikan komunikasi yang aman dan memvalidasi identitas Anda sebagai pengguna yang berwenang. REST API.
Fitur Utama
- Jenis Kolom FormulirTambahkan kolom formulir TextBox dan CheckBox ke PDF dokumen
- Penentuan Posisi yang TepatKontrol penempatan lapangan dengan koordinat X dan Y yang tepat.
- Ukuran Bidang KustomSesuaikan dimensi kolom formulir agar sesuai dengan persyaratan desain.
- Penargetan Halaman yang FleksibelTerapkan kolom formulir ke halaman tertentu atau seluruh dokumen.
- Nilai Awal: Tetapkan nilai default untuk kolom formulir
- Base64 Pengkodean: Transmisi konten file yang aman menggunakan Base64 pengkodean
- Sederhana API Integrasi: RESTful API dirancang untuk otomatis PDF alur kerja pembuatan formulir
Titik Akhir API REST
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi penambahan kolom formulir dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
/api/v2/AddFormField
Parameter API REST
Daftar lengkap parameter untuk Menambahkan Kolom Formulir ke PDF REST APIParameter-parameter tersebut diorganisir berdasarkan kategori untuk pemahaman dan implementasi yang lebih baik.
Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi dan harus diberikan agar dapat digunakan. API agar berfungsi dengan benar.
Parameter yang Diperlukan
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| Konten dokumen* | Base64 | Isi dari input PDF berkas yang dikodekan dalam Base64 | JVBERi... |
| Nama dokumen* | String | Sumber PDF nama file dengan ekstensi .pdf | output.pdf |
| nilai awal* | String | Nilai awal untuk kolom formulir | New input text |
| posisiX* | Integer | Posisi X dari kolom formulir pada halaman | 300 |
| posisiY* | Integer | Posisi Y kolom formulir pada halaman | 300 |
| nama bidang* | String | Nama kolom formulir | Input Field Name |
| Ukuran* | Integer | Ukuran kolom formulir | 4 |
| halaman* | String | Opsi halaman: "1" untuk halaman 1, "1,3,5" untuk halaman tertentu, "2-5" untuk rentang halaman, "1,3,7-10" untuk campuran, "1-" untuk halaman dari 1 hingga akhir. | 1 |
| JenisBidangFormulir* | String | Jenis kolom formulir: Kotak Teks atau Kotak centang | TextBox |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| asinkron | Boolean | Aktifkan pemrosesan asinkron. Saat true, itu API mengembalikan status 202 dan menyediakan polling URL di header Lokasi | true |
Keluaran
Yang PDF4me Tambahkan Kolom Formulir ke PDF REST API Mengembalikan respons yang berbeda berdasarkan mode pemrosesan. API mengembalikan PDF sebagai data biner untuk pemrosesan sinkron atau menyediakan polling URL untuk pemrosesan asinkron.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Pemrosesan Sinkron (Default)
Kapan async tidak diatur atau diatur ke false, itu API memproses permintaan tersebut dengan segera:
Kode Status: 200 OK
Tipe Konten: application/pdf atau application/octet-stream
Isi Tanggapan:
Yang API mengembalikan PDF file langsung sebagai data biner (bukan JSON).
Cara Penggunaan:
- Isi respons berisi biner. PDF data
- Simpan konten respons langsung sebagai PDF berkas
- TIDAK Base64 Dekode diperlukan untuk respons biner.
Contoh (JavaScript):
const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly
Pemrosesan Asinkron
Kapan async: true sudah ditetapkan, API memproses permintaan secara asinkron:
Kode Status: 202 Accepted
Header Respons:
Location: https://api.pdf4me.com/api/v2/AddFormField/poll/12345-abcde-67890
Proses Pemungutan Suara:
- Ekstrak
Locationheader dari respons 202 - Jajak pendapat URL menggunakan GET permintaan
- Lanjutkan jajak pendapat hingga Anda menerima 200 OK status
- Respons akhir berisi nilai biner. PDF data
Contoh Polling:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const pdfBlob = await pollResponse.blob();
// Process binary PDF
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
Respons Kesalahan
| Kode Status | Keterangan | Contoh Jawaban |
|---|---|---|
| 400 Bad Request | Parameter permintaan tidak valid atau kolom wajib hilang. | {"error": "Missing required parameter: fieldName"} |
| 401 Unauthorized | Tidak valid atau hilang API kunci | {"error": "Unauthorized"} |
| 500 Internal Server Error | Terjadi kesalahan server selama pemrosesan. | {"error": "Internal server error"} |
Memahami Respons
- Sinkron (200): Mengembalikan nilai biner PDF data langsung
- Asinkron (202)Mengembalikan header Lokasi untuk polling, respons akhir berupa biner. PDF
- TIDAK JSON Pembungkus: Itu API pengembalian PDF sebagai biner, tidak dibungkus dalam JSON dengan Base64 pengkodean
Contoh Permintaan
Judul
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Catatan: Yang API kunci harus Base64 dienkode. Dapatkan milikmu API kunci dari PDF4me Dasbor
Muatan
{
"docContent": "Please put PDF base64 content",
"docName": "output.pdf",
"initialValue": "input text",
"positionX": 300,
"positionY": 300,
"fieldName": "Input Field Name",
"Size": 4,
"pages": "1",
"formFieldType": "TextBox"
}
Contoh Kode
Yang PDF4me Tambahkan Kolom Formulir ke PDF REST API Menyediakan contoh kode dalam berbagai bahasa pemrograman. Pilih bahasa yang paling sesuai dengan lingkungan pengembangan Anda:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Contoh
Menyelesaikan C# implementasi untuk menambahkan kolom formulir ke PDF:
Java Contoh
Java Implementasi dengan penanganan kesalahan dan pemrosesan respons yang lengkap:
JavaScript Contoh
Node.js dan kompatibel dengan browser JavaScript implementasi:
Google Apps Script Contoh
Google Apps Script implementasi untuk Google Workspace integrasi:
Fitur Pembuatan Kolom Formulir
Jenis Kolom Formulir
- Kolom Kotak TeksBuat kolom input teks untuk memasukkan data pengguna dan menyelesaikan formulir.
- Kolom Kotak CentangTambahkan elemen kotak centang untuk opsi pemilihan dan konfirmasi.
- Ukuran KhususSesuaikan dimensi bidang agar sesuai dengan persyaratan desain dan kebutuhan konten.
- Hasil ProfesionalPembuatan kolom formulir berkualitas tinggi dengan fungsionalitas yang akurat.
- Pemrosesan LanjutanDukungan untuk tata letak formulir dan pengaturan kolom yang kompleks.
Penempatan dan Tata Letak
- Koordinat TepatKontrol penempatan bidang dengan nilai posisi X dan Y yang tepat.
- Penempatan Fleksibel: Mendukung posisi halaman dan pengaturan bidang apa pun
- Penargetan HalamanTerapkan kolom formulir ke halaman tertentu atau seluruh dokumen.
- Ukuran KhususDimensi bidang yang dapat disesuaikan untuk desain formulir yang optimal.
- Tata Letak ProfesionalPenempatan kolom formulir yang konsisten di semua halaman target.
Fitur Lanjutan
- Nilai AwalTetapkan nilai default untuk kolom agar pengalaman pengguna lebih baik.
- Penamaan BidangNama kolom kustom untuk pengumpulan dan pemrosesan data formulir.
- Kreasi ProfesionalPembuatan kolom formulir berkualitas tinggi dengan fungsionalitas yang jelas.
- Opsi FleksibelParameter kolom formulir yang dapat disesuaikan untuk kebutuhan spesifik.
Studi Kasus & Aplikasi Industri
- Legal & Professional Services
- Healthcare & Medical
- Finance & Banking
- Human Resources
- Business & Enterprise
Studi Kasus Layanan Hukum & Profesional
- Formulir KontrakTambahkan kolom formulir ke kontrak dan perjanjian untuk tanda tangan digital.
- Dokumentasi HukumBuat formulir interaktif untuk pemrosesan dokumen hukum.
- Formulir Kepatuhan: Membuat formulir untuk kepatuhan dan dokumentasi peraturan
- Penerimaan Klien: Membuat formulir pendaftaran klien untuk layanan hukum
Kasus Penggunaan di Bidang Kesehatan & Medis
- Formulir PasienBuat formulir pendaftaran pasien dan riwayat medis yang interaktif.
- Dokumentasi Medis: Membuat formulir untuk rekam medis dan dokumentasi
- Klaim Asuransi: Merancang formulir untuk pemrosesan klaim asuransi
- Formulir Persetujuan: Membuat formulir persetujuan dan otorisasi untuk prosedur medis
Studi Kasus Keuangan & Perbankan
- Aplikasi Keuangan: Membuat formulir permohonan pinjaman dan kredit
- Pembukaan RekeningBuat formulir untuk pembukaan rekening dan proses KYC.
- Formulir Transaksi: Merancang formulir untuk transaksi dan pemrosesan keuangan
- Dokumentasi KepatuhanBuat formulir untuk pelaporan kepatuhan peraturan.
Studi Kasus Sumber Daya Manusia
- Pemrosesan Aplikasi: Membuat formulir aplikasi untuk lamaran dan pendaftaran pekerjaan
- Orientasi Karyawan BaruBuat formulir untuk orientasi dan dokumentasi karyawan.
- Pembuatan Survei: Merancang survei dan kuesioner interaktif di PDF format
- Tinjauan KinerjaBuat formulir untuk evaluasi kinerja dan umpan balik.
Kasus Penggunaan Bisnis & Perusahaan
- Otomatisasi DokumenBuat formulir interaktif untuk pengumpulan dan pengolahan data.
- Pengumpulan DataBuat formulir untuk mengumpulkan informasi dan umpan balik pelanggan.
- Dokumen InteraktifTambahkan kolom formulir ke yang sudah ada. PDFs untuk meningkatkan keterlibatan pengguna
- Otomatisasi Proses BisnisBuat formulir untuk alur kerja bisnis otomatis dan entri data.