Ganti Teks - Penggantian Teks API
PDF4me Ganti Teks Memungkinkan Anda untuk mencari dan mengganti teks dalam dokumen Word dengan opsi pencarian tingkat lanjut. Ini API Layanan ini memproses file Word dan melakukan beberapa operasi penggantian dengan pencocokan peka huruf besar/kecil dan pencocokan kata utuh. API menerima konten dokumen Word melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk beberapa operasi pencarian dan penggantian dalam satu permintaan, solusi ini ideal untuk otomatisasi dokumen, pemrosesan templat, dan alur kerja manajemen konten.
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 BergandaLakukan beberapa operasi pencarian dan penggantian dalam satu tindakan.
- Opsi Pencarian LanjutanPencocokan peka huruf besar/kecil dan pencocokan kata utuh
- Pemrosesan BerurutanBeberapa penggantian diproses sesuai urutan yang ditentukan.
- Pencocokan Fleksibel: Pencocokan persis, pencocokan sebagian, atau pencocokan kata utuh
- Struktur SederhanaSerangkaian operasi pencarian dan penggantian yang mudah digunakan.
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi penggantian teks dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/ReplaceText
REST API Parameter
Daftar lengkap parameter untuk Penggantian Teks REST APIParameter-parameter tersebut diorganisir berdasarkan kategori untuk pemahaman dan implementasi yang lebih baik.
Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi. Parameter tersebut frasa Larik tersebut harus berisi setidaknya satu frasa pengganti.
Parameter yang Diperlukan
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| dokumen* | Object | Referensi dokumen. Harus memuat Nama (string): Nama file Word dengan ekstensi .docx | { "Name": "document.docx" } |
| Konten dokumen* | Base64 | Konten dokumen Word yang dikodekan dalam Base64Penggantian teks dilakukan pada dokumen ini. | UEsDBBQABgAIAAAA... |
| frasa* | Array | Array objek pengganti. Harus berisi setidaknya satu pengganti. Setiap pengganti diproses secara berurutan sesuai urutan yang ditentukan. | Lihat contoh di bawah ini. |
Struktur Objek Penggantian Teks (susunan frasa)
Setiap item dalam frasa Array harus berupa objek dengan struktur berikut:
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| temukanTeks* | String | String teks yang akan dicari dalam dokumen. Tidak boleh null atau kosong. Peka terhadap huruf besar/kecil atau tidak peka terhadap huruf besar/kecil berdasarkan pengaturan matchCase. Semua kemunculan teks ini akan diganti. | "old text" |
| gantiTeks | String | Teks yang akan menggantikan teks yang ditemukan. Dapat berupa string kosong untuk menghapus teks yang ditemukan. Default: string kosong (menghapus teks yang ditemukan) | "new text" |
| kotak korek api | Boolean | Pencocokan peka huruf besar/kecil. true = Pencarian peka terhadap huruf besar dan kecil (pencocokan huruf besar dan kecil yang tepat diperlukan), false = Pencarian tidak peka huruf besar/kecil (default). Mengontrol apakah "The" cocok dengan "the" atau hanya "The" | false |
| cocokkan Seluruh Kata | Boolean | Pencocokan kata utuh. true = Cocokkan hanya kata-kata lengkap (bukan kecocokan sebagian), false = Mencocokkan sebagian teks dalam kata (default). Mencegah "the" agar tidak cocok dengan "there" atau "other". | false |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| nama budaya | String | Kode budaya untuk pemrosesan dokumen (misalnya, "en-US", "de-DE", "fr-FR") | en-US |
Pemrosesan Penggantian Teks
- Setiap penggantian diproses secara berurutan sesuai dengan urutan yang ditentukan.
- Beberapa penggantian dapat dilakukan pada dokumen yang sama.
- Semua kemunculan Find Text akan diganti (kecuali jika menggunakan pencocokan kata utuh).
Keluaran
Yang PDF4me Ganti Teks REST API Mengembalikan respons yang berbeda berdasarkan mode pemrosesan. API mengembalikan dokumen Word sebagai Base64-string yang dikodekan dalam JSON format, bukan sebagai data biner.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Pemrosesan Sinkron (Default)
Yang API Memproses permintaan dan mengembalikan:
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 penggantian teks yang diterapkan, dikodekan sebagai Base64 rangkaian
- nama file (string): Nama file Word keluaran
- kesuksesan (boolean): Menunjukkan apakah permintaan berhasil
- pesan kesalahan (string atau null): Detail kesalahan ketika keberhasilan bernilai salah
Cara Penggunaan:
- Ekstrak
documentlapangan dari JSON tanggapan (Base64) - Uraikan kodenya Base64 string untuk mendapatkan data biner dokumen Word
- Simpan atau proses file Word sesuai kebutuhan.
Contoh (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
Pemrosesan Asinkron
Perilaku asinkron (202 Accepted (dengan polling) dikendalikan oleh konfigurasi server, bukan oleh parameter body permintaan. Saat diaktifkan, API dapat mengembalikan status 202 dengan polling URL di dalam Location Judul. Jajak pendapat URL dengan GET permintaan hingga Anda menerima 200 OK dengan bentuk respons yang sama (dokumen, nama file, sukses, pesan kesalahan).
Respons Kesalahan
Yang API pengembalian standar HTTP Kode kesalahan beserta detail kesalahannya:
- Parameter permintaan tidak valid
- Kolom yang wajib diisi belum terisi (
dokumendenganNama,Konten dokumen,frasa) - Array frasa bernilai null atau kosong.
- Teks yang dicari bernilai null atau kosong dalam penggantian.
- Tidak sah Base64 pengkodean dalam
Konten dokumen - Dokumen Word tidak valid atau rusak
- Ukuran font atau parameter pemformatan tidak valid
- 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
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:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or 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.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['docContent'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.docx", 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 (Penggantian Tunggal):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"phrases": [
{
"findText": "old text",
"replaceText": "new text",
"matchCase": false,
"matchWholeWord": false
}
],
"cultureName": "en-US"
}
Contoh Lanjutan (Penggantian Berganda):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"phrases": [
{
"findText": "[COMPANY_NAME]",
"replaceText": "Acme Corporation",
"matchCase": false,
"matchWholeWord": false
},
{
"findText": "[DATE]",
"replaceText": "2024-01-15",
"matchCase": false,
"matchWholeWord": false
},
{
"findText": "[CONTACT_EMAIL]",
"matchCase": false,
"matchWholeWord": false
}
],
"cultureName": "en-US"
}
Contoh Kode
Yang PDF4me Ganti Teks 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 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 teks placeholder dengan informasi khusus klien
- Otomatisasi Dokumen HukumPerbarui nomor kasus, nama klien, dan tanggal.
- Standardisasi Templat: Menstandarisasi terminologi dan format hukum
- Komunikasi dengan KlienPersonalisasikan dokumen hukum untuk klien tertentu.
Kasus Penggunaan Bisnis & Perusahaan
- Pembuatan ProposalGanti templat proposal dengan informasi khusus klien.
- Pembuatan Materi PemasaranPerbarui templat pemasaran dengan detail kampanye.
- Komunikasi dengan KlienPersonalisasikan dokumen penjualan untuk prospek tertentu.
- Standardisasi Laporan: Standarisasi terminologi dan format penjualan
Studi Kasus Pendidikan & Penelitian
- Pembuatan Laporan MedisGanti templat medis dengan informasi spesifik pasien.
- Komunikasi PasienPersonalisasikan dokumen medis untuk pasien tertentu.
- Dokumentasi PenelitianPerbarui templat penelitian dengan data spesifik studi.
- Dokumentasi KepatuhanPerbarui templat kepatuhan medis dengan standar terkini.
Studi Kasus Keuangan & Perbankan
- Pembuatan Laporan KeuanganGanti data templat dengan metrik keuangan aktual.
- Pemrosesan FakturPerbarui templat faktur dengan informasi klien dan pembayaran.
- Otomatisasi Dokumen AnggaranGanti angka sementara dalam anggaran dengan angka sebenarnya.
- Pembuatan Laporan AuditPerbarui templat audit dengan temuan audit spesifik.