Pisahkan Dokumen - Pembagian Dokumen API
PDF4me Dokumen Terpisah Memungkinkan Anda untuk membagi dokumen Word menjadi beberapa dokumen yang lebih kecil dengan opsi pemisahan yang fleksibel dan kontrol konfigurasi yang komprehensif. Ini API Layanan ini memproses file Word dan memisahkannya berdasarkan halaman, bagian, judul, atau rentang halaman khusus dengan kendali penuh atas kriteria pemisahan, penamaan dokumen, dan pengorganisasian output. API menerima konten dokumen Word melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk pemisahan berdasarkan halaman, pembagian berdasarkan bagian, pemisahan berdasarkan judul, dan rentang halaman khusus, solusi ini ideal untuk manajemen dokumen, distribusi konten, dan otomatisasi alur kerja.
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
- Beberapa Jenis PemisahanPisahkan berdasarkan halaman, bagian, judul, atau rentang khusus.
- Dukungan Rentang Halaman: Dipisahkan berdasarkan nomor halaman atau rentang tertentu
- Pemisahan Berdasarkan BagianPisahkan dokumen setelah setiap bagian Word.
- Pembagian Berdasarkan JudulPisahkan dokumen setelah setiap judul dengan gaya yang ditentukan (misalnya, Judul 1, Judul 2)
- Konfigurasi FleksibelKriteria pemisahan khusus dengan parameter splitConfig
- Nama Dokumen UnikSetiap dokumen yang dipisah akan mendapatkan nama file GUID yang unik.
- Pelestarian FormatMempertahankan format dan struktur dokumen asli.
- Dukungan Budaya: Pemrosesan dokumen khusus lokal
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi pemisahan dokumen dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/SplitDocument
REST API Parameter
Daftar lengkap parameter untuk Dokumen Terpisah 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
splitConfigparameter diperlukan ketikasplitTypeadalah "array", "numberofpages", atau "headings".
Parameter yang Diperlukan
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| dokumen* | Object | Referensi dokumen. Harus memuat Nama (string): Nama file Word dengan ekstensi .docx. Digunakan untuk referensi dan pemrosesan. | { "Name": "document.docx" } |
| Konten dokumen* | Base64 | Konten dokumen Word yang dikodekan dalam Base64Dokumen akan dipisahkan berdasarkan kriteria yang ditentukan. Harus berupa dokumen Word yang valid (.docx, .doc format) | base64EncodedDocumentContent |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| Tipe terpisah | String | Jenis pemisahan dokumen. Opsi: allpages - Terbagi menjadi halaman-halaman individual (standar), array - Dipisahkan berdasarkan rentang halaman tertentu (misalnya, "1-3,4,5-7"), numberofpages - Pisahkan setelah setiap N halaman (konfigurasi: bilangan bulat positif seperti "3" atau "5"), section - Pisahkan dokumen setelah setiap bagian, headings - Pisahkan dokumen setelah setiap judul dengan gaya yang diberikan (misalnya, "Judul 1"). Setiap dokumen yang dipisahkan mendapatkan nomor unik. GUID nama file | "allpages" |
| splitConfig | String | Konfigurasi untuk pemisahan. Untuk array: Rentang halaman seperti "1-3,4,5-7" (halaman 1-3, halaman 4, halaman 5-7) atau halaman tunggal "1,3,5". Untuk jumlah halaman: Bilangan bulat positif seperti "3" atau "5" : dipisahkan setelah setiap N halaman. Untuk judulNama gaya judul seperti "Judul 1" atau "Judul 2". Diperlukan saat splitType adalah "array", "numberofpages", atau "headings". Nomor halaman berbasis 1. Pencocokan judul tidak peka huruf besar/kecil. | "1-3,4,5-7" atau "3" atau "Heading 1" |
| nama budaya | String | Kode budaya untuk pemrosesan dokumen (misalnya, "en-US", "de-DE", "fr-FR"). Default: "en-US". Mempengaruhi bahasa dan format dokumen. Digunakan untuk metadata dan penanganan lokalisasi. | en-US |
Opsi Tipe Terpisah
Yang API menyediakan berbagai tipe pemisahan untuk pembagian dokumen:
| Tipe Terpisah | Keterangan | Membutuhkan splitConfig | Kasus Penggunaan |
|---|---|---|---|
| allpages | Terbagi menjadi halaman-halaman individual (default) | TIDAK | Ekstrak setiap halaman sebagai dokumen terpisah. |
| array | Dipisahkan berdasarkan rentang halaman yang jelas. Setiap rentang yang dipisahkan koma menjadi satu dokumen (misalnya, "1-3,4,5-7" → 3 dokumen) | Ya | Buat dokumen dari rentang halaman tertentu atau halaman tunggal. |
| numberofpages | Dipisahkan setelah setiap N halaman. Pemisahan dilakukan secara berurutan: setiap N halaman membentuk satu dokumen; sisanya adalah dokumen terakhir. | Ya | Bagi menjadi bagian-bagian berukuran sama (misalnya setiap 3 atau 5 halaman) |
| section | Pisahkan dokumen setelah setiap bagian Word. | TIDAK | Satu dokumen per bagian |
| headings | Pisahkan dokumen setelah setiap judul dengan gaya yang ditentukan (misalnya, "Judul 1"). | Ya | Ekstrak bab atau bagian berdasarkan tingkat judul. |
Contoh Konfigurasi Terpisah
Memahami konfigurasi pemisahan membantu mengoptimalkan alur kerja pemisahan dokumen Anda:
array: rentang halaman eksplisit
"1-3,4,5-7"→ 3 dokumen: halaman 1-3, halaman 4, halaman 5-7"1,3,5"→ 3 dokumen: halaman 1, halaman 3, halaman 5"1-5,6-10"→ 2 dokumen: halaman 1-5, halaman 6-10
numberofpages: dipisahkan setelah setiap N halaman
Perilaku: Terpisah secara berurutan setelah setiap N halaman.
Konfigurasi: Wajib diisi, formatnya adalah bilangan bulat positif tunggal (misalnya...). "3", "5").
Contoh:
- Konfigurasi
"3"Pada dokumen 10 halaman → 4 dokumen: Dokumen 1: halaman 1-3, Dokumen 2: halaman 4-6, Dokumen 3: halaman 7-9, Dokumen 4: halaman 10 - Konfigurasi
"5"Pada dokumen 12 halaman → 3 dokumen: Dokumen 1: halaman 1-5, Dokumen 2: halaman 6-10, Dokumen 3: halaman 11-12
headings: dipisahkan setelah setiap judul
"Heading 1", satu dokumen per blok yang berakhir pada Heading 1 berikutnya (atau akhir dokumen)"Heading 2", satu dokumen per blok yang berakhir pada Heading 2 berikutnya (atau akhir dokumen)- Pencocokan tanpa memperhatikan huruf besar/kecil
section
Tidak diperlukan konfigurasi. Dokumen akan terpisah setelah setiap pemisah bagian Word; setiap bagian menjadi satu dokumen.
Keluaran
Yang PDF4me Dokumen Terpisah REST API mengembalikan hasil pemisahan sebagai JSON. Itu API Mengembalikan satu dokumen tunggal dalam respons (dokumen terpisah pertama), dengan bidang respons standar.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Pemrosesan Sinkron (Default)
Yang API memproses permintaan dan mengembalikan dokumen terpisah pertama:
Kode Status: 200 OK
Tipe Konten: application/json
Isi Tanggapan:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx",
"success": true,
"errorMessage": null
}
Kolom Respons:
- dokumen (string): Konten dokumen terpisah pertama, dikodekan sebagai Base64 rangkaian
- nama file (string): Nama file yang dihasilkan untuk dokumen yang dipisah (GUID-berdasarkan)
- 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
- Gunakan
fileNameuntuk menyimpan dokumen yang terpisah
Contoh (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save with data.fileName or custom name
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) - Konfigurasi pemisahan yang diberikan tidak valid.
splitConfigdiperlukan ketikaTipe terpisahadalah "array", "numberofpages", atau "headings"- Tidak sah Base64 pengkodean dalam
Konten dokumen - Dokumen Word tidak valid atau rusak
- Tidak ditemukan judul dalam dokumen (untuk pemisahan berdasarkan judul)
- Rentang halaman yang ditentukan tidak valid (nomor halaman melebihi jumlah halaman dokumen)
- Tipe pemisahan 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
- Kesalahan pemisahan dokumen
- Terjadi kesalahan saat memuat dokumen dari byte.
- Terjadi kesalahan saat mengkonversi dokumen ke byte.
Format Respons Kesalahan:
{
"error": "Error message describing what went wrong"
}
Detail Format Respons
Penting: Yang API selalu kembali JSON dengan serangkaian dokumen, bukan data Word biner secara langsung.
Struktur Respons:
{
"document": "string", // Base64-encoded Word document content (first split)
"fileName": "string", // GUID-based filename (e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx")
"success": true,
"errorMessage": "string or null"
}
Header Content-Type:
- Kesuksesan:
application/json - Dokumen yang terpisah 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
// Save with response.fileName or custom name
Python:
import base64
response_data = response.json()
word_bytes = base64.b64decode(response_data['document'])
filename = response_data['fileName']
with open(filename, '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 Dasar (Pisahkan Semua Halaman - Default):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "allpages"
}
Contoh Rentang Halaman (array):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "array",
"splitConfig": "1-3,4,5-7"
}
Contoh Pemisahan Setelah Setiap N Halaman (jumlah halaman):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "numberofpages",
"splitConfig": "3"
}
Contoh Berdasarkan Judul (dipisahkan setelah setiap judul):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "headings",
"splitConfig": "Heading 1",
"cultureName": "en-US"
}
Contoh Berdasarkan Bagian (dipisahkan setelah setiap bagian):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "section",
"cultureName": "en-US"
}
Contoh Kode
Yang PDF4me Dokumen Terpisah 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
- Manajemen KontrakPisahkan kontrak multipihak menjadi bagian-bagian individual.
- Dokumentasi KasusEkstrak halaman-halaman tertentu dari berkas kasus.
- Laporan KepatuhanBagikan bagian-bagian yang relevan ke berbagai departemen.
- Penelitian HukumPisahkan dokumen hukum yang besar berdasarkan topik atau bagian.
Kasus Penggunaan Bisnis & Perusahaan
- Distribusi LaporanLaporan dibagi berdasarkan bagian untuk berbagai pemangku kepentingan.
- Manajemen ProposalEkstrak bagian-bagian untuk hasil akhir yang spesifik untuk klien.
- Dokumentasi InternalPisahkan buku panduan berdasarkan topik atau departemen.
- Organisasi Arsip: Membuat bagian-bagian dokumen logis untuk penyimpanan dan pengambilan
Studi Kasus Pendidikan & Penelitian
- Materi KurikulumPisahkan buku teks menjadi bab-bab individual.
- Catatan SiswaEkstrak halaman spesifik untuk berbagai departemen akademik.
- Makalah Penelitian: Pisahkan makalah besar berdasarkan bagian untuk tinjauan sejawat
- Dokumentasi Medis dan PenelitianPisahkan dokumen penelitian atau klinis berdasarkan metodologi atau bagian.
Studi Kasus Keuangan & Perbankan
- Laporan Keuangan: Mendistribusikan bagian-bagian tertentu kepada berbagai pemangku kepentingan
- Dokumentasi AuditEkstrak halaman-halaman yang relevan untuk berbagai area audit.
- Kepatuhan RegulasiPisahkan dokumen kepatuhan berdasarkan jenis peraturan.
- Penilaian Risiko: Distribusikan bagian-bagian risiko kepada tim yang sesuai