Bandingkan Dokumen - Perbandingan Dokumen API
PDF4me Bandingkan Dokumen Memungkinkan Anda membandingkan dua dokumen Word dan melacak perubahan dengan opsi perbandingan yang komprehensif. Ini API Layanan ini memproses dua file Word dan menghasilkan dokumen perbandingan dengan pelacakan perubahan terperinci, pengaturan perbandingan yang dapat disesuaikan, manajemen revisi, dan laporan perbandingan profesional. API menerima isi dokumen melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan kontrol penuh atas pemformatan, sensitivitas huruf besar/kecil, komentar, tabel, kolom, catatan kaki, kotak teks, dan header/footer, solusi ini ideal untuk peninjauan dokumen, kontrol versi, dan alur kerja pengeditan kolaboratif.
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
- Perbandingan DokumenBandingkan dua dokumen Word dan identifikasi semua perbedaannya.
- Lacak Perubahan: Menghasilkan dokumen dengan pelacakan perubahan yang menunjukkan modifikasi
- Opsi yang Dapat Disesuaikan: Mengontrol jenis perubahan apa yang akan dilacak atau diabaikan
- Manajemen RevisiBersihkan revisi yang ada sebelum perbandingan.
- Atribusi PenulisTetapkan perubahan kepada penulis tertentu untuk akuntabilitas.
- Hasil Profesional: Menghasilkan dokumen perbandingan yang rapi dengan pelacakan revisi
- Dukungan Berbagai Format: Bandingkan file .docx dan .doc
- Penyaringan LanjutanAbaikan format, perubahan huruf besar/kecil, komentar, tabel, dan lainnya.
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi perbandingan dokumen dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/CompareDocuments
REST API Parameter
Daftar lengkap parameter untuk Membandingkan Dokumen 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 |
|---|---|---|---|
| Dokumen pertama* | Object | Referensi dokumen pertama (dasar). Harus berisi Nama (string): nama dokumen dengan ekstensi (.docx, .doc). Dokumen ini berfungsi sebagai dasar perbandingan. | { "Name": "original.docx" } |
| firstDocContent* | Base64 | Base64-Konten yang dienkode dari dokumen pertama. Harus berupa dokumen Word yang valid (.docx, .doc format) | UEsDBBQABgAIAAAA... |
| Dokumen kedua* | Object | Referensi dokumen kedua (perbandingan). Harus memuat Nama (string): nama dokumen dengan ekstensi (.docx, .doc). Dokumen ini dibandingkan dengan yang pertama | { "Name": "modified.docx" } |
| Konten Dokumen Kedua* | Base64 | Base64-Konten yang dienkode dari dokumen kedua. Harus berupa dokumen Word yang valid (.docx, .doc format) | UEsDBBQABgAIAAAA... |
Parameter Opsional (Opsi Perbandingan)
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| opsi perbandingan | Object | Pengaturan perbandingan. Properti: abaikanPemformatan (boolean), abaikan perubahan huruf besar/kecil (boolean), abaikan komentar (boolean), abaikanTabel (boolean), abaikan kolom (boolean), abaikan catatan kaki (boolean), abaikan kotak teks (boolean), abaikanHeaderDanFooter (boolean), pengarang (string). Lihat Opsi Perbandingan di bawah ini | { "ignoreFormatting": false, "author": "John Doe" } |
Opsi Perbandingan
Yang API memberikan kontrol yang lebih rinci atas perubahan apa yang akan dilacak:
Opsi Konten:
- abaikanPemformatanFokus pada konten teks, abaikan perubahan gaya.
- abaikan perubahan huruf besar/kecilPerbandingan tidak peka huruf besar/kecil
- abaikan komentarKecualikan perubahan komentar dari perbandingan.
- abaikanTabel: Kecualikan perubahan struktur dan isi tabel
- abaikan kolomKecualikan pembaruan kolom (konten yang diperbarui secara otomatis)
Opsi Elemen Dokumen:
- abaikan catatan kaki: Kecualikan perubahan catatan kaki
- abaikan kotak teksKecualikan perubahan kotak teks
- abaikanHeaderDanFooter: Kecualikan perubahan header/footer
Sumber:
- pengarang: Tetapkan nama penulis untuk perubahan yang dilacak dalam dokumen perbandingan
Keluaran
Yang PDF4me Bandingkan Dokumen 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": "comparison-result.docx",
"success": true,
"errorMessage": null
}
Kolom Respons:
- dokumen (string): Dokumen Word dengan perubahan yang dilacak yang menunjukkan semua perbedaan, dikodekan sebagai Base64 rangkaian
- nama file (string): Nama file Word keluaran beserta hasil perbandingannya
- kesuksesan (boolean): Menunjukkan apakah permintaan berhasil
- pesan kesalahan (string atau null): Detail kesalahan jika keberhasilan bernilai false
Cara Penggunaan:
- Ekstrak
documentlapangan dari JSON tanggapan (Base64) - Uraikan kodenya Base64 string untuk mendapatkan data biner dokumen Word
- Buka dokumen di Word untuk meninjau perubahan yang dilacak.
- Terima atau tolak perubahan 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 - document contains tracked changes
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 (
Dokumen pertamadenganNama,firstDocContent,Dokumen keduadenganNama,Konten Dokumen Kedua) - Dokumen pertama kosong atau null
- Dokumen kedua kosong atau null
- Tidak sah Base64 pengkodean dalam konten dokumen
- Dokumen Word tidak valid atau rusak
- 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 perbandingan dokumen
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 with tracked changes
"fileName": "string", // Output Word filename with comparison results
"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.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('comparison.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("comparison.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 (Hanya Kolom yang Wajib Diisi):
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}
Contoh Lanjutan (Dengan Opsi Perbandingan):
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"comparisonOptions": {
"ignoreFormatting": false,
"ignoreCaseChanges": false,
"ignoreComments": true,
"ignoreTables": false,
"ignoreFields": true,
"ignoreFootnotes": false,
"ignoreTextboxes": false,
"ignoreHeadersAndFooters": false,
"author": "Legal Review System"
}
}
Contoh Perbandingan Hanya Berdasarkan Konten:
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"comparisonOptions": {
"ignoreFormatting": true,
"ignoreCaseChanges": true,
"ignoreComments": true,
"ignoreFields": true,
"author": "Content Review"
}
}
Contoh Kode
Yang PDF4me Bandingkan Dokumen 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
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
- Tinjauan KontrakBandingkan versi kontrak untuk mengidentifikasi perubahan dan modifikasi.
- Pembaruan Dokumen HukumMelacak perubahan dalam berkas hukum, perjanjian, dan dokumen pengadilan.
- Pemantauan KepatuhanBandingkan dokumen kebijakan untuk memastikan kepatuhan terhadap peraturan.
- Peninjauan Dokumen KlienMelacak perubahan pada dokumen hukum yang ditujukan kepada klien.
Kasus Penggunaan Bisnis & Perusahaan
- Manajemen ProposalBandingkan versi proposal untuk melacak kebutuhan klien.
- Pembaruan Materi PemasaranMelacak perubahan pada materi pemasaran dan kampanye.
- Perubahan Dokumen HargaBandingkan lembar harga dan daftar tarif.
- Pembaruan Presentasi KlienMelacak perubahan pada materi presentasi klien
Studi Kasus Pendidikan & Penelitian
- Pembaruan Protokol MedisBandingkan dokumen prosedur dan protokol medis.
- Pedoman Perawatan PasienMelacak perubahan dalam dokumentasi perawatan pasien
- Dokumentasi PenelitianBandingkan protokol penelitian dan dokumen studi.
- Dokumentasi KepatuhanMelacak perubahan pada materi kepatuhan layanan kesehatan
Studi Kasus Keuangan & Perbankan
- Pembaruan Laporan KeuanganBandingkan laporan keuangan triwulanan dan tahunan.
- Perubahan Dokumen AnggaranMelacak perubahan dalam proposal dan laporan anggaran.
- Dokumentasi AuditBandingkan laporan audit di berbagai periode.
- Pengajuan PeraturanMelacak perubahan dalam dokumen pengajuan regulasi