Ganti Teks dengan Gambar - Penggantian Gambar API
PDF4me Ganti Teks dengan Gambar Memungkinkan Anda mengganti teks tertentu dengan gambar dalam dokumen Word dengan opsi penyaringan halaman dan kontrol ukuran tingkat lanjut. Ini API Layanan ini memproses file Word dan mengganti placeholder teks dengan gambar menggunakan pencocokan teks yang tepat, ukuran yang dapat disesuaikan dengan mempertahankan rasio aspek, penargetan khusus halaman, dan opsi pemfilteran yang fleksibel. API menerima konten dokumen Word dan data gambar melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk berbagai format gambar dan kontrol penuh atas perilaku penggantian, solusi ini ideal untuk otomatisasi dokumen, pemrosesan templat, dan alur kerja penyisipan konten dinamis.
Memverifikasi Identitas Anda API Meminta
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
- Penggantian Teks ke Gambar: Mengganti string teks tertentu dengan gambar di seluruh dokumen
- Pencocokan Teks yang TepatPencarian dan penggantian teks yang peka terhadap huruf besar/kecil.
- Kontrol Ukuran GambarSesuaikan dimensi gambar dengan parameter lebar dan tinggi.
- Pelestarian Rasio AspekPertahankan proporsi gambar saat mengubah ukurannya.
- Penyaringan Halaman: Menargetkan halaman atau rentang halaman tertentu untuk penggantian
- Penyaringan LanjutanLewati halaman pertama, targetkan halaman ganjil/genap, atau tentukan nomor halaman yang tepat.
- Berbagai Format Gambar: Dukungan untuk PNG, JPG, JPEG, BMP, GIF format
- Penempatan FleksibelSisipkan gambar sebagai bentuk Word dengan penempatan yang tepat.
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi penggantian teks ke gambar dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/ReplaceTextWithImage
REST API Parameter
Daftar lengkap parameter untuk fungsi Ganti Teks dengan Gambar REST APIParameter-parameter tersebut diorganisir berdasarkan kategori untuk pemahaman dan implementasi yang lebih baik.
Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi. Parameter lanjutan memberikan kontrol yang lebih detail atas ukuran gambar dan pemfilteran halaman.
Parameter yang Diperlukan
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| dokumen* | Object | Deskripsi dokumen. Harus mencakup Nama (string): menghasilkan nama file Word dengan ekstensi .docx | { "Name": "document.docx" } |
| Konten dokumen* | Base64 | Konten dokumen Word yang dikodekan dalam Base64Penggantian teks dilakukan pada dokumen ini. Harus berupa dokumen Word yang valid (.docx, .doc format) | base64EncodedDocumentContent |
| temukanTeks* | String | String teks yang akan dicari dalam dokumen. Peka terhadap huruf besar/kecil. Semua kemunculan akan diganti dengan gambar. Tidak boleh null atau kosong. Contoh: "[LOGO]", "SIGN_HERE" | "text to replace" |
| Konten gambar* | Base64 | Konten file gambar pengganti yang dikodekan dalam Base64. Harus berupa gambar yang valid (PNG, JPG, JPEG, BMP, GIF) | base64EncodedImageContent |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| lebar | Angka (ganda) | Lebar gambar | 200 |
| tinggi | Angka (ganda) | Tinggi gambar | 100 |
| pertahankanRasioAspek | Boolean | Pertahankan proporsi gambar selama pengubahan ukuran. Default: true | true |
| Lewati halaman pertama | Boolean | Lewati penggantian pada halaman pertama. true = lewati halaman pertama, false = sertakan (default). Berguna untuk halaman sampul/judul | false |
| applyTo | String | Lingkup target untuk penggantian | - |
| Nomor halaman | String | Nomor atau rentang halaman tertentu (misalnya, "1,2,3" atau "1,3,5-7"). Kosong = semua halaman | "1,2,3" |
| abaikanNomorHalaman | String | Nomor halaman yang tidak termasuk dalam penggantian. | - |
| nama budaya | String | Kode budaya (misalnya, "en-US", "fr-FR", "de-DE"). Bawaan: nol | en-US |
Penyaringan Halaman
Yang API Mendukung pemfilteran halaman melalui parameter berikut:
- Lewati halaman pertama: Mengontrol apakah akan melewati halaman pertama
- Nomor halaman: Menentukan halaman mana yang akan diproses (string kosong = semua halaman)
- abaikanNomorHalamanNomor halaman yang akan dikecualikan
Format Gambar yang Didukung
Mengganti Teks dengan Gambar API Mendukung berbagai format gambar untuk kompatibilitas maksimal:
| Format | Perpanjangan | Keterangan |
|---|---|---|
| PNG | .png | Portable Network Graphics (PNG) - paling cocok untuk logo dan grafik dengan transparansi. |
| JPEG | .jpg, .jpeg | Joint Photographic Experts Group - terbaik untuk foto dan gambar kompleks. |
| BMP | .bmp | Bitmap - format tidak terkompresi, ukuran file lebih besar. |
| GIF | GIF | Format Pertukaran Grafis (Graphics Interchange Format) - mendukung animasi dan transparansi. |
Keluaran
Yang PDF4me Ganti Teks dengan Gambar REST API mengembalikan JSON tanggapan (ApiV2WordApiCallRes). Setelah berhasil, API mengembalikan dokumen Word sebagai Base64-string yang dikodekan di dalam document bidang, bukan sebagai data biner.
- Success Response
- Error Responses
- Response Format Details
Respons Sukses
Kode Status: 200 OK
Tipe Konten: application/json
Isi Tanggapan:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
Kolom Respons:
- dokumen (string): Dokumen Word dengan teks yang diganti dengan gambar, dikodekan sebagai Base64
- nama file (string): Nama file Word keluaran
- kesuksesan (boolean): Apakah operasi tersebut berhasil
- pesan kesalahan (string): Pesan kesalahan jika keberhasilan bernilai salah; jika tidak, bernilai null.
Cara Penggunaan:
- Memeriksa
success; jika benar, ekstrakdocumentlapangan dari JSON tanggapan - Uraikan kodenya Base64 string untuk mendapatkan data biner dokumen Word
- Simpan atau proses file Word menggunakan
fileName
Contoh (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const wordBytes = atob(data.document);
// Save or process wordBytes
Respons Kesalahan
Yang API pengembalian standar HTTP Kode kesalahan beserta detail kesalahannya:
- Parameter permintaan tidak valid
- Kolom yang wajib diisi belum terisi (
dokumen,Konten dokumen,temukanTeks,Konten gambar) - FindText bernilai null atau kosong
- ImageContent bernilai null atau kosong
- Tidak sah Base64 pengkodean dalam
Konten dokumenatauKonten gambar - Dokumen Word tidak valid atau rusak
- Berkas gambar tidak valid atau rusak
- Tidak ada halaman yang sesuai dengan kriteria penyaringan.
- Tidak valid atau hilang API kunci
- API kunci tidak berfungsi dengan benar Base64 dikodekan dalam Authorization judul
- Hilang
Otorisasi: Dasarjudul
- Kesalahan pemrosesan sisi server
- Kegagalan pemrosesan dokumen Word
- Kegagalan penggantian teks
- Kegagalan penyisipan gambar
Format Respons Kesalahan:
{
"error": "Error message describing what went wrong"
}
Detail Format Respons
Penting: Yang API selalu kembali JSON, jangan pernah menggunakan data Word biner secara langsung.
Struktur Respons (ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": null
}
Header Content-Type:
- Kesuksesan:
application/json - Dokumen Word disematkan sebagai Base64 tali di dalam JSON tanggapan
Mengapa Base64?
- JSON- Pengkodean aman untuk data biner
- Mudah ditransmisikan melalui HTTP
- Kompatibel dengan semua bahasa pemrograman
- Dapat langsung disematkan di JSON tanpa menghindari masalah
Mendekode Base64 ke Dokumen Word:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, wordBytes);
Contoh Permintaan
Judul
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Catatan:
- Dapatkan milikmu API kunci dari PDF4me Dasbor
- Yang API kunci harus Base64 dikodekan dan diawali dengan "Basic" di dalam Authorization judul
- Contoh: Jika Anda API kuncinya adalah
abc123, mengkodekannya menjadi Base64 dan menggunakanAuthorization: Basic YWJjMTIz
Muatan
Contoh Sederhana (Hanya Kolom yang Wajib Diisi):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"cultureName": "en-US"
}
Contoh Lanjutan (Dengan Kolom Opsional):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"width": 200,
"height": 100,
"maintainAspectRatio": true,
"skipFirstPage": true,
"pageNumbers": "1,2,3",
"ignorePageNumbers": null,
"cultureName": "en-US"
}
Contoh Kode
Yang PDF4me Ganti Teks dengan Gambar 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 mengganti teks dengan gambar dalam dokumen Word:
Java Contoh
Java Implementasi dengan penanganan kesalahan dan pemrosesan respons yang lengkap:
JavaScript Contoh
Node.js dan kompatibel dengan browser JavaScript implementasi:
Google Script Contoh
Google Apps Script implementasi untuk Google Workspace integrasi:
Studi Kasus & Aplikasi Industri
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Studi Kasus Layanan Hukum & Profesional
- Pemrosesan Kontrak: Ganti tempat penampung tanda tangan dengan tanda tangan yang sah
- Otomatisasi Dokumen Hukum: Sisipkan logo dan tanda air perusahaan ke dalam dokumen hukum
- Personalisasi Dokumen KlienTambahkan gambar khusus klien ke dokumen hukum.
- Dokumentasi Kepatuhan: Sisipkan stempel dan segel kepatuhan ke dalam dokumen
Kasus Penggunaan Bisnis & Perusahaan
- Pembuatan ProposalSisipkan logo perusahaan dan gambar produk ke dalam proposal.
- Pembuatan Materi Pemasaran: Ganti teks placeholder dengan gambar pemasaran
- Otomatisasi Presentasi KlienSisipkan gambar khusus klien ke dalam presentasi.
- Pembuatan Laporan PenjualanSisipkan bagan dan grafik penjualan ke dalam laporan.
Studi Kasus Pendidikan & Penelitian
- Pembuatan Laporan MedisSisipkan bagan dan diagram medis ke dalam laporan.
- Pemrosesan Dokumen PasienSisipkan logo fasilitas medis ke dalam dokumen pasien.
- Dokumentasi PenelitianSisipkan bagan dan grafik penelitian ke dalam makalah penelitian.
- Dokumentasi Kepatuhan: Sisipkan stempel kepatuhan medis ke dalam dokumen
Studi Kasus Keuangan & Perbankan
- Pembuatan Laporan KeuanganSisipkan bagan dan grafik ke dalam laporan keuangan.
- Pemrosesan Faktur: Ganti placeholder logo dengan logo perusahaan
- Dokumentasi Audit: Sisipkan stempel dan tanda tangan audit ke dalam laporan audit
- Otomatisasi Laporan AnggaranSisipkan bagan anggaran ke dalam dokumen anggaran.