Optimalkan Dokumen - Optimasi Dokumen API
PDF4me Optimalkan Dokumen Memungkinkan Anda mengoptimalkan dokumen Word untuk ukuran dan kinerja dengan tiga tingkat kompresi berbeda dan teknik optimasi komprehensif. Ini API Layanan ini memproses file Word dan mengurangi ukuran file, mengompres gambar, membersihkan konten, menormalkan format, dan menghapus informasi pribadi. API menerima konten dokumen Word melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk tingkat optimasi Rendah, Sedang, dan Tinggi yang mencapai pengurangan ukuran file 0-90%, solusi ini ideal untuk persiapan dokumen, optimasi penyimpanan, dan alur kerja peningkatan kinerja.
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
- Optimasi MaksimumProfil kompresi maksimum untuk pengurangan ukuran file maksimal.
- Pengurangan Ukuran FileRaih pengurangan ukuran file 80-90% dengan optimasi Max.
- Kompresi GambarOptimasi gambar cerdas dengan mempertahankan kualitas.
- Pembersihan KontenHapus makro, komentar, dan konten tersembunyi yang tidak digunakan.
- Normalisasi PemformatanBersihkan format yang berlebihan dan gaya yang tidak digunakan.
- Penghapusan Informasi PribadiHapus informasi penulis, manajer, dan perusahaan.
- Optimasi Font: Normalisasi font dan hapus properti font yang tidak perlu
- Peningkatan KompatibilitasOptimalkan dokumen agar kompatibel dengan Word 2016.
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi optimasi dokumen dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/OptimizeDocument
REST API Parameter
Daftar lengkap parameter untuk Optimasi Dokumen REST APIParameter-parameter tersebut diorganisir berdasarkan kategori untuk pemahaman dan implementasi yang lebih baik.
Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi. Tingkat optimasi menentukan agresivitas teknik optimasi yang diterapkan.
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 Base64Dokumen asli tidak dimodifikasi - versi baru yang dioptimalkan telah dibuat. | UEsDBBQABgAIAAAA... |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| tingkat optimasi | String | Tingkat optimasi (misalnya Rendah, Sedang, Maksimum). Maksimum - Kompresi maksimum (~80-90%). Mengontrol agresivitas teknik optimasi. | "Max" |
| Versi kata | String | Versi Word target untuk kompatibilitas | null |
| nama budaya | String | Kode budaya untuk pemrosesan dokumen (misalnya, "en-US", "de-DE", "fr-FR") | en-US |
Profil Optimasi
Yang Maksimum Profil optimasi memberikan kompresi maksimum:
- Pengurangan Ukuran File: 80-90%
- Kualitas GambarDioptimalkan untuk ukuran
- Pemformatan: Pembersihan agresif
- Komentar: DIHAPUS
- Revisi: DIHAPUS
- Informasi Pribadi: DIHAPUS
- Makro: DIHAPUS
- Gaya yang Tidak Digunakan: DIHAPUS
- Konten Tersembunyi: DIHAPUS
Keluaran
Yang PDF4me Optimalkan 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": "document.docx",
"success": true,
"errorMessage": null
}
Kolom Respons:
- dokumen (string): Dokumen Word yang dioptimalkan dengan ukuran file yang lebih kecil, 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 (
dokumendenganNama,Konten dokumen) - Tidak sah Base64 pengkodean dalam
Konten dokumen - Dokumen Word tidak valid atau rusak
- Tingkat optimasi 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 optimasi dokumen
- Terjadi kesalahan saat menerapkan pengaturan kompresi.
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 (Optimasi Maksimum Default):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max"
}
Contoh Lanjutan (Dengan Kolom Opsional):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max",
"wordVersion": null,
"cultureName": "en-US"
}
Contoh Kode
Yang PDF4me Optimalkan 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
- Distribusi DokumenOptimalkan dokumen hukum untuk didistribusikan kepada klien.
- Pengajuan Publik: Menyiapkan dokumen untuk pengajuan ke pengadilan umum
- Penyimpanan ArsipOptimalkan dokumen hukum untuk penyimpanan jangka panjang.
- Dokumen Kepatuhan: Merapikan dokumen untuk pengajuan regulasi
Kasus Penggunaan Bisnis & Perusahaan
- Distribusi ProposalOptimalkan proposal untuk pengiriman kepada klien.
- Berbagi Materi PemasaranOptimalkan dokumen pemasaran untuk distribusi publik.
- Optimalisasi PresentasiOptimalkan presentasi untuk distribusi email.
- Persiapan Hasil Kerja untuk Klien: Merapikan dokumen untuk pengiriman kepada klien
Studi Kasus Pendidikan & Penelitian
- Distribusi Laporan PasienOptimalkan laporan medis untuk berbagi yang aman.
- Dokumentasi PenelitianOptimalkan dokumen penelitian untuk publikasi.
- Berbagi ProtokolOptimalkan protokol medis untuk distribusi departemen.
- Dokumentasi Kepatuhan: Merapikan dokumen untuk pengajuan regulasi
Studi Kasus Keuangan & Perbankan
- Distribusi Laporan KeuanganOptimalkan laporan keuangan untuk didistribusikan kepada pemangku kepentingan.
- Dokumentasi Audit: Merapikan dokumen audit untuk dibagikan secara eksternal
- Berbagi Dokumen AnggaranOptimalkan dokumen anggaran untuk distribusi departemen.
- Pengajuan Peraturan: Menyiapkan dokumen untuk pengajuan ke badan regulasi