Ekstrak Metadata dari Word - Analisis Dokumen API
PDF4me Ekstrak Metadata dari Word Memungkinkan Anda mengekstrak metadata dan properti komprehensif dari dokumen Word dengan kemampuan analisis dokumen yang mendetail. Ini API Layanan ini memproses file Word dan mengambil properti dokumen bawaan, properti khusus, statistik dokumen, informasi penulis, tanggal pembuatan, dan pelacakan revisi. API menerima konten dokumen Word melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk format dan lokalisasi khusus budaya, solusi ini ideal untuk manajemen dokumen, pelacakan kepatuhan, analisis konten, dan alur kerja dokumen perusahaan.
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
- Ekstraksi Metadata Komprehensif: Mengambil semua properti dokumen bawaan dan kustom
- Statistik DokumenDapatkan jumlah halaman, jumlah kata, jumlah karakter, dan jumlah paragraf secara real-time.
- Informasi PenulisEkstrak nama penulis, manajer, perusahaan, dan detail kontak.
- Properti Tanggal/Waktu: Mengambil stempel waktu pembuatan, modifikasi, dan pencetakan
- Properti KustomAkses semua properti dokumen kustom dengan awalan otomatis.
- Dukungan BudayaFormat tanggal dan waktu sesuai dengan lokal yang ditentukan.
- Operasi Baca SajaEkstrak metadata tanpa mengubah dokumen asli.
- Keluaran Terstruktur: Mengembalikan metadata yang terorganisir dalam JSON format untuk memudahkan pemrosesan
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi ekstraksi metadata dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Word/ExtractMetadata
REST API Parameter
Daftar lengkap parameter untuk Ekstrak Metadata dari Word 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* | 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 | UEsDBBQABgAIAAAA... |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| nama budaya | String | Kode budaya untuk pemformatan tanggal/waktu (misalnya, "en-US", "de-DE", "fr-FR"). Default: InvariantCulture (pemformatan konsisten). Mempengaruhi format tampilan tanggal/waktu dalam metadata. Budaya yang tidak valid akan kembali ke InvariantCulture. | en-US |
Keluaran
Yang PDF4me Ekstrak Metadata dari Word REST API Mengembalikan respons yang berbeda berdasarkan mode pemrosesan. API mengembalikan metadata sebagai JSON objek, 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": null,
"fileName": null,
"success": true,
"errorMessage": null,
"metadata": {
"Author": "John Doe",
"Title": "Project Proposal",
"Subject": "Q1 2024 Planning",
"Keywords": "planning, budget, strategy",
"Comments": "Draft version for review",
"Category": "Business",
"Company": "Acme Corporation",
"Manager": "Jane Smith",
"Created": "1/15/2024 10:30:00 AM",
"LastModified": "1/20/2024 2:45:00 PM",
"LastPrinted": "1/18/2024 9:15:00 AM",
"RevisionNumber": 3,
"TotalEditingTime": 120,
"Pages": 8,
"Words": 2150,
"Characters": 12800,
"Paragraphs": 45,
"Custom_Department": "Marketing",
"Custom_ProjectCode": "PRJ-2024-001",
"Custom_Confidential": "Internal"
}
}
Kolom Respons:
- dokumen (Base64 atau null): Tidak digunakan untuk ekstraksi metadata; mungkin null
- nama file (string atau null): Tidak digunakan untuk ekstraksi metadata; mungkin null
- kesuksesan (boolean): Menunjukkan apakah permintaan berhasil
- pesan kesalahan (string atau null): Detail kesalahan jika keberhasilan bernilai false
- metadata (objek): Kamus metadata komprehensif yang berisi semua properti dokumen
Cara Penggunaan:
- Ekstrak
metadatalapangan dari JSON tanggapan - Akses properti individual sesuai kebutuhan.
- Gunakan metadata untuk klasifikasi dokumen, pelacakan kepatuhan, atau analisis.
Contoh (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const author = data.metadata.Author;
const pageCount = data.metadata.Pages;
// Access any metadata property
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 (termasuk metadata, success, errorMessage).
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 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 ekstraksi metadata
Format Respons Kesalahan:
{
"error": "Error message describing what went wrong"
}
Detail Format Respons
Penting: Yang API selalu kembali JSON dengan objek metadata.
Struktur Respons:
{
"document": "Base64 or null",
"fileName": "string or null",
"success": true,
"errorMessage": "string or null",
"metadata": {
// Built-in properties
"Author": "string",
"Title": "string",
"Subject": "string",
"Keywords": "string",
"Comments": "string",
"Category": "string",
"Company": "string",
"Manager": "string",
"Created": "string (formatted date/time)",
"LastModified": "string (formatted date/time)",
"LastPrinted": "string (formatted date/time)",
"RevisionNumber": "integer",
"TotalEditingTime": "integer (minutes)",
// Document statistics
"Pages": "integer",
"Words": "integer",
"Characters": "integer",
"Paragraphs": "integer",
// Custom properties (prefixed with Custom_)
"Custom_PropertyName": "value"
}
}
Header Content-Type:
- Kesuksesan:
application/json - Metadata dikembalikan sebagai struktur terstruktur. JSON objek
Mengakses Metadata:
JavaScript/Node.js:
const metadata = response.metadata;
console.log(`Author: ${metadata.Author}`);
console.log(`Pages: ${metadata.Pages}`);
console.log(`Words: ${metadata.Words}`);
Python:
metadata = response['metadata']
print(f"Author: {metadata['Author']}")
print(f"Pages: {metadata['Pages']}")
print(f"Words: {metadata['Words']}")
C#:
var metadata = response.Metadata;
Console.WriteLine($"Author: {metadata["Author"]}");
Console.WriteLine($"Pages: {metadata["Pages"]}");
Console.WriteLine($"Words: {metadata["Words"]}");
Properti Metadata
Properti Dokumen Bawaan
| Nama Properti | Jenis | Keterangan | Contoh |
|---|---|---|---|
| Pengarang | String | Nama penulis dokumen | "John Doe" |
| Judul | String | Judul dokumen | "Project Proposal" |
| Subjek | String | Subjek dokumen | "Q1 2024 Planning" |
| Kata kunci | String | Kata kunci dokumen (dipisahkan koma) | "planning, budget, strategy" |
| Komentar | String | Komentar dokumen | "Draft version for review" |
| Kategori | String | Kategori dokumen | "Business" |
| Perusahaan | String | Nama perusahaan | "Acme Corporation" |
| Manajer | String | Nama manajer | "Jane Smith" |
| Dibuat | String | Tanggal/waktu pembuatan dokumen (diformat) | "1/15/2024 10:30:00 AM" |
| Terakhir Diubah | String | Tanggal/waktu terakhir disimpan (diformat) | "1/20/2024 2:45:00 PM" |
| TerakhirDicetak | String | Tanggal/waktu cetak terakhir (diformat) | "1/18/2024 9:15:00 AM" |
| Nomor Revisi | Integer | Nomor revisi dokumen | 3 |
| TotalWaktuPengeditan | Integer | Total waktu pengeditan dalam menit | 120 |
Statistik Dokumen
| Nama Properti | Jenis | Keterangan | Contoh |
|---|---|---|---|
| Halaman | Integer | Jumlah total halaman | 8 |
| Kata-kata | Integer | Jumlah kata total | 2150 |
| Karakter | Integer | Jumlah karakter total | 12800 |
| Paragraf | Integer | Jumlah paragraf total | 45 |
Properti Kustom
Properti kustom diawali dengan Custom_ dalam tanggapannya:
Custom_Department- Properti departemen khususCustom_ProjectCode- Properti kode proyek kustomCustom_Confidential- Tingkat kerahasiaan khusus- Properti kustom lainnya yang didefinisikan dalam dokumen Word.
Contoh Budaya yang Didukung
| Kode Budaya | Keterangan | Contoh Format Tanggal |
|---|---|---|
en-US | Bahasa Inggris (Amerika Serikat) | "15/01/2024 10:30:00 AM" |
en-GB | Bahasa Inggris (Britania Raya) | "15/01/2024 10:30:00" |
de-DE | Jerman (Jerman) | "15.01.2024 10:30:00" |
fr-FR | Bahasa Prancis (Prancis) | "15/01/2024 10:30:00" |
es-ES | Bahasa Spanyol (Spanyol) | "15/01/2024 10:30:00" |
ja-JP | Bahasa Jepang (Jepang) | "15/01/2024 10:30:00" |
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):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}
Contoh Lanjutan (Dengan Kolom Opsional):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"cultureName": "en-US"
}
Contoh Kode
Yang PDF4me Ekstrak Metadata dari Word 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
- Klasifikasi DokumenKlasifikasikan dokumen hukum berdasarkan jenis kasus, klien, atau bidang praktik.
- Pelacakan KepatuhanPantau tanggal pembuatan dokumen dan riwayat revisi untuk kepatuhan terhadap peraturan.
- Manajemen Dokumen Klien: Melacak properti dokumen untuk pengorganisasian file klien
- Pemeliharaan Jejak Audit: Mencatat metadata dokumen untuk keperluan audit hukum
Kasus Penggunaan Bisnis & Perusahaan
- Manajemen ProposalEkstrak metadata dari proposal untuk pelacakan dan analisis klien.
- Organisasi Materi PemasaranKlasifikasikan dokumen pemasaran berdasarkan kampanye dan target audiens.
- Analisis Kinerja KontenAnalisis statistik dokumen untuk optimasi konten.
- Pelacakan Hasil Kerja Klien: Memantau properti dokumen untuk manajemen proyek klien
Studi Kasus Pendidikan & Penelitian
- Klasifikasi Dokumen MedisKlasifikasikan dokumen medis berdasarkan pasien, prosedur, atau departemen.
- Dokumentasi PenelitianEkstrak metadata dari dokumen penelitian untuk pelacakan studi.
- Catatan Akademik dan PasienMengatur dokumen akademis dan pasien berdasarkan properti metadata.
- Kepatuhan dan Etika: Memantau metadata dokumen untuk kepatuhan regulasi di bidang kesehatan dan penelitian
Studi Kasus Keuangan & Perbankan
- Analisis Laporan KeuanganEkstrak metadata dari laporan keuangan untuk pelacakan kepatuhan.
- Manajemen Dokumen AnggaranKlasifikasikan dokumen anggaran berdasarkan departemen dan tahun fiskal.
- Dokumentasi Audit: Melacak properti dokumen untuk pemeliharaan jejak audit
- Pengajuan Peraturan: Memantau metadata dokumen untuk persyaratan pengajuan regulasi