Perbarui Daftar Isi - TOC Manajemen API
PDF4me Perbarui Daftar Isi Memungkinkan Anda untuk memperbarui atau membuat Daftar Isi dalam dokumen Word dengan opsi pemformatan yang komprehensif dan kemampuan penataan gaya profesional. Ini API Layanan ini memproses file Word dan menghasilkan output. TOCdengan deteksi otomatis yang sudah ada TOC kolom, tingkat judul yang dapat disesuaikan, dukungan hyperlink, kontrol pemimpin tab, opsi huruf besar/kecil, dan lokalisasi budaya. API menerima konten dokumen Word melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan kendali penuh atas TOC Dari segi tampilan dan fungsionalitas, solusi ini ideal untuk navigasi dokumen, pemformatan profesional, dan otomatisasi. TOC alur kerja generasi.
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
- Otomatis TOC Deteksi: Menemukan dan memperbarui yang sudah ada TOC kolom atau membuat kolom baru
- Tingkat Judul yang Dapat Disesuaikan: Mengontrol tingkat judul mana yang akan disertakan (1-6)
- Dukungan HyperlinkAktifkan atau nonaktifkan tautan yang dapat diklik di TOC
- Kontrol Pemimpin TabTampilkan atau sembunyikan titik di antara teks dan nomor halaman.
- Opsi Huruf Kapital TeksGunakan huruf kapital atau pertahankan huruf asli.
- Lokalisasi BudayaDukungan untuk berbagai bahasa dan wilayah
- Pemformatan Profesional: Penerapan profesional secara otomatis TOC penataan gaya
- Integrasi Nomor Halaman: Perhitungan dan pembaruan nomor halaman otomatis
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi pembaruan daftar isi dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/UpdateTableOfContents
REST API Parameter
Daftar lengkap parameter untuk Pembaruan Daftar Isi 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 rinci atas TOC Pemformatan dan tampilan.
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 Base64. TOC Dihasilkan dari judul-judul dokumen ini. Harus berupa dokumen Word yang valid (.docx, .doc format) | UEsDBBQABgAIAAAA... |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| Tingkat judul | String | Tingkat judul yang perlu disertakan dalam TOCFormat rentang: "1-3" (termasuk level judul 1, 2, dan 3). Level tunggal: "1". Rentang ganda: "1-2, 4-6". Default: "1-3". Memetakan ke gaya judul bawaan Word. Memindai dokumen untuk mencari yang sudah ada. TOC kolom. Membuat yang baru TOC di awal dokumen jika tidak ada | "1-3" |
| Gunakan hyperlink | Boolean | Sertakan hyperlink dalam Daftar Isi. true = TOC Entri berupa tautan yang dapat diklik (default), false = teks biasa | true |
| sembunyikanTabLeader | Boolean | Sembunyikan titik penunjuk tab. true = Tidak ada titik di antara teks dan nomor halaman (standar), false = Titik di antara teks dan nomor halaman | true |
| gunakan huruf besar | Boolean | Gunakan huruf kapital untuk TOC entri. true = TOC entri dalam huruf besar (default), false = kasus asli | true |
| nama budaya | String | Kode budaya untuk pemrosesan dokumen (misalnya, "en-US", "de-DE", "fr-FR"). Nilai default: null. Mempengaruhi bahasa dan format dokumen. | en-US |
TOC Perilaku Generasi
- Yang ada TOC DeteksiMemindai dokumen untuk mencari dokumen yang sudah ada. TOC bidang (FieldType.FieldTOC) dan memperbaruinya
- Baru TOC Penciptaan: Jika tidak TOC ada, menciptakan yang baru TOC di awal dokumen
- Pemetaan Tingkat Judul: Dipetakan ke gaya judul bawaan Word (Judul 1, Judul 2, dll.)
- Pembaruan Lapangan: Memperbarui kolom beberapa kali untuk akurasi
- Tata Letak HalamanMemanggil UpdateFields() dan UpdatePageLayout() secara berurutan
Keluaran
Yang PDF4me Perbarui Daftar Isi 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 daftar isi yang diperbarui, 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) - Tidak sah Base64 pengkodean dalam
Konten dokumen - Dokumen Word tidak valid atau rusak
- Tidak ditemukan judul dalam dokumen.
- Tingkat tajuk yang ditentukan tidak valid (format tidak valid)
- Nama budaya yang diberikan 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 pembaruan daftar isi
- 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, 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 Dasar (Pengaturan Default):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}
Contoh Lanjutan (Dengan Semua Opsi):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"headingLevels": "1-4",
"useHyperlinks": true,
"hideTabLeader": false,
"useUppercase": false,
"cultureName": "en-US"
}
Contoh Makalah Akademik:
{
"document": { "Name": "research-paper.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"headingLevels": "1-3",
"useHyperlinks": true,
"hideTabLeader": true,
"useUppercase": true
}
Contoh Kode
Yang PDF4me Perbarui Daftar Isi 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 memperbarui daftar isi 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
- Navigasi KontrakBuat daftar isi terperinci untuk kontrak yang kompleks.
- Ringkasan Hukum: Menghasilkan struktur yang mudah dinavigasi untuk dokumen pengadilan
- Manual Kepatuhan: Persyaratan dan prosedur peraturan indeks
- Dokumentasi Kasus: Mengorganisir bukti dan argumen hukum
Kasus Penggunaan Bisnis & Perusahaan
- Buku Panduan Kebijakan: Indeks prosedur dan kebijakan internal
- Struktur Proposal: Membuat struktur yang mudah dinavigasi untuk proposal dan RFP
- Materi Pelatihan: Mengatur pelatihan internal dan dokumen orientasi karyawan baru
- Dokumentasi Proyek: Menyusun rencana proyek dan hasil yang diharapkan
Studi Kasus Pendidikan & Penelitian
- Pengindeksan Buku TeksBuat daftar isi yang komprehensif untuk materi pendidikan.
- Makalah Penelitian: Menstandarisasi struktur dokumen akademik
- Buku Panduan Medis dan Klinis: Prosedur indeks, protokol, dan materi studi
- Dokumentasi TesisStruktur kerja pascasarjana dan doktoral
Studi Kasus Keuangan & Perbankan
- Laporan KeuanganBuat struktur yang mudah dinavigasi untuk laporan yang kompleks.
- Buku Panduan KebijakanProsedur dan peraturan perbankan indeks
- Dokumentasi Audit: Mengatur materi kepatuhan dan audit
- Panduan Investasi: Menyusun konten pendidikan keuangan