Gabungkan Dokumen - Perakitan Dokumen API
PDF4me Gabungkan Dokumen Memungkinkan Anda menggabungkan beberapa dokumen Word menjadi satu dokumen dengan opsi pemformatan dan kepatuhan tingkat lanjut. Ini API Layanan ini memproses beberapa file Word dan menggabungkannya dengan pengaturan urutan dokumen yang fleksibel, mode pemformatan yang dapat disesuaikan, pengaturan tingkat kepatuhan, metadata zona waktu, dan penanganan gaya yang cerdas. API menerima isi dokumen melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk penggabungan dokumen tanpa batas dan kontrol penuh atas perilaku penggabungan, solusi ini ideal untuk perakitan dokumen, konsolidasi laporan, 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
- Dukungan untuk Banyak DokumenMenggabungkan dokumen dalam jumlah tak terbatas menjadi satu.
- Struktur Array Sederhana: Susunan yang mudah digunakan Base64-isi dokumen yang dikodekan
- Penggabungan TerurutDokumen digabungkan sesuai urutan kemunculannya dalam larik.
- Konsep Dokumen DasarDokumen pertama menjadi dasar untuk penggabungan.
- Dukungan Berbagai FormatGabungkan dokumen Word, PDF, dan format lain yang didukung.
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi penggabungan dokumen dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/MergeDocuments
REST API Parameter
Daftar lengkap parameter untuk Penggabungan Dokumen 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 dokumen Array harus berisi setidaknya satu dokumen.
Parameter yang Diperlukan
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| dokumen* | Array | Array objek dokumen yang akan digabungkan. Harus berisi setidaknya satu dokumen. Setiap objek harus memiliki nama file (tali) dan Konten dokumen (Base64 (string). Dokumen digabungkan sesuai urutan kemunculannya dalam larik. Bidang opsional per dokumen: sortirPosisi (bilangan bulat), formatMode (rangkaian) | [{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }] |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| opsi penggabungan | Object | Opsi penggabungan (pemformatan, kepatuhan, dll.). Lihat model plugin untuk properti yang tersedia. | {} |
Urutan Penggabungan Dokumen
Dokumen digabungkan sesuai urutan kemunculannya. dokumen array:
- Dokumen pertama dalam array menjadi dokumen dasar
- Semua dokumen selanjutnya adalah ditambahkan ke dokumen dasar dalam urutan array
Keluaran
Yang PDF4me Gabungkan 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": "merged-document.docx",
"success": true,
"errorMessage": null
}
Kolom Respons:
- dokumen (string): Dokumen Word gabungan yang berisi semua dokumen masukan, dikodekan sebagai Base64 rangkaian
- nama file (string): Nama file Word keluaran
- 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
- 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 (
dokumenarray) - Tidak ada dokumen untuk digabungkan (larik dokumen kosong)
- Tidak sah Base64 pengkodean dalam konten dokumen
- Dokumen 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 penggabungan 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 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.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("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 (Dua Dokumen):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
]
}
Contoh Lanjutan (Beberapa Dokumen dengan Opsi Penggabungan):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
{ "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
],
"mergeOptions": {}
}
Contoh Kode
Yang PDF4me Gabungkan 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
- Perakitan KontrakGabungkan bagian-bagian kontrak menjadi dokumen hukum yang lengkap.
- Konsolidasi Ringkasan HukumGabungkan beberapa bagian singkat menjadi ringkasan hukum yang komprehensif.
- Dokumentasi Kepatuhan: Mengkonsolidasikan dokumen kepatuhan untuk pengajuan regulasi
- Penyusunan Dokumen Klien: Menggabungkan dokumen khusus klien menjadi paket lengkap
Kasus Penggunaan Bisnis & Perusahaan
- Susunan ProposalGabungkan bagian-bagian proposal menjadi proposal klien yang lengkap.
- Konsolidasi Materi PemasaranGabungkan dokumen pemasaran untuk kampanye.
- Presentasi Penjualan - PerakitanGabungkan bagian-bagian presentasi menjadi presentasi yang lengkap.
- Penyusunan Hasil yang Harus Diserahkan kepada Klien: Mengkonsolidasikan materi khusus klien
Studi Kasus Pendidikan & Penelitian
- Susunan Laporan MedisGabungkan bagian-bagian laporan medis menjadi laporan pasien yang lengkap.
- Dokumentasi ProtokolGabungkan bagian-bagian protokol menjadi protokol medis yang komprehensif.
- Dokumentasi Penelitian: Mengkonsolidasikan dokumen penelitian untuk laporan studi
- Perakitan Manual Kepatuhan: Gabungkan dokumen kepatuhan layanan kesehatan
Studi Kasus Keuangan & Perbankan
- Susunan Laporan KeuanganGabungkan bagian-bagian laporan keuangan menjadi laporan lengkap.
- Dokumentasi Audit: Mengkonsolidasikan dokumen audit untuk laporan audit yang komprehensif
- Konsolidasi Anggaran: Menggabungkan bagian anggaran dari departemen yang berbeda
- Majelis Pengajuan RegulasiGabungkan dokumen peraturan untuk pengajuan.