Estrazione di metadati da Word - Analisi del documento API
PDF4me Estrai metadati da Word consente di estrarre metadati e proprietà complete da documenti Word con funzionalità di analisi dettagliata del documento. Questo API Il servizio elabora i file Word e recupera le proprietà predefinite del documento, le proprietà personalizzate, le statistiche del documento, le informazioni sull'autore, le date di creazione e il monitoraggio delle revisioni. API riceve il contenuto del documento Word tramite REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Grazie al supporto per la formattazione specifica per cultura e la localizzazione, questa soluzione è ideale per la gestione dei documenti, il monitoraggio della conformità, l'analisi dei contenuti e i flussi di lavoro documentali aziendali.
Autenticazione del tuo API Richiesta
Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.
Caratteristiche principali
- Estrazione completa dei metadati: Recupera tutte le proprietà predefinite e personalizzate del documento
- Statistiche del documentoOttieni il conteggio in tempo reale di pagine, parole, caratteri e paragrafi.
- Informazioni sui frigoriferi: Estrai autore, responsabile, azienda e dettagli di contatto
- Proprietà di data/oraRecupera i timestamp di creazione, modifica e stampa.
- Proprietà personalizzate: Accedi a tutte le proprietà personalizzate del documento con prefisso automatico
- Supporto culturaleFormatta date e orari in base alle impostazioni locali specificate.
- Operazione di sola letturaEstrazione dei metadati senza modificare il documento originale
- Output strutturato: Restituisci i metadati organizzati in JSON formato per una facile elaborazione
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP metodi per interagire con le risorse. Tutte le operazioni di estrazione dei metadati vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
office/ApiV2Word/ExtractMetadata
REST API Parametri
Elenco completo dei parametri per l'estrazione dei metadati da Word REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori e devono essere forniti per il API per funzionare correttamente.
Parametri richiesti
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| documento* | Object | Riferimento al documento. Deve contenere Nome (stringa): Nome del file Word con estensione .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Il contenuto del documento Word codificato in Base64 | UEsDBBQABgAIAAAA... |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| Nome della cultura | String | Codice cultura per la formattazione di data/ora (ad esempio, "en-US", "de-DE", "fr-FR"). Predefinito: InvariantCulture (formattazione coerente). Influisce sul formato di visualizzazione di data/ora nei metadati. Le culture non valide utilizzano InvariantCulture. | en-US |
Produzione
IL PDF4me Estrai metadati da Word REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce i metadati come un JSON oggetto, non come dati binari.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Elaborazione sincrona (impostazione predefinita)
IL API elabora la richiesta e restituisce:
Codice di stato: 200 OK
Tipo di contenuto: application/json
Corpo della risposta:
{
"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"
}
}
Campi di risposta:
- documento Base64 o null): Non utilizzato per l'estrazione dei metadati; può essere null
- Nome file (stringa o null): Non utilizzato per l'estrazione dei metadati; può essere null
- successo (booleano): Indica se la richiesta è andata a buon fine
- messaggio di errore (stringa o null): Dettagli dell'errore quando il successo è falso
- metadati (oggetto): Dizionario di metadati completo contenente tutte le proprietà del documento
Come si usa:
- Estrarre il
metadatacampo dal JSON risposta - Accedere alle singole proprietà secondo necessità.
- Utilizzare i metadati per la classificazione dei documenti, il monitoraggio della conformità o l'analisi.
Esempio (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
Elaborazione asincrona
Comportamento asincrono (202 Accepted con polling) è controllato dalla configurazione del server, non da un parametro del corpo della richiesta. Quando abilitato, il API potrebbe restituire uno stato 202 con un polling URL nel Location intestazione. Interroga l' URL con GET richieste fino a quando non ne ricevi 200 OK con la stessa forma di risposta (incluso metadata, success, errorMessage).
Risposte di errore
IL API resi standard HTTP Codici di errore con dettagli dell'errore:
- Parametri di richiesta non validi
- Campi obbligatori mancanti (
documentoconNome,docContent) - Non valido Base64 codifica in
docContent - Documento Word non valido o danneggiato
- Non valido o mancante API chiave
- API chiave non corretta Base64 codificato in Authorization intestazione
- Mancante
Autorizzazione: Baseintestazione
- Errore di elaborazione lato server
- Errore nell'elaborazione del documento Word
- Errore nell'estrazione dei metadati
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSON con oggetto metadati.
Struttura della risposta:
{
"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"
}
}
Intestazione Content-Type:
- Successo:
application/json - I metadati vengono restituiti come una struttura JSON oggetto
Accesso ai metadati:
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"]}");
Proprietà dei metadati
Proprietà predefinite del documento
| Nome della proprietà | Tipo | Descrizione | Esempio |
|---|---|---|---|
| Autore | String | Nome dell'autore del documento | "John Doe" |
| Titolo | String | Titolo del documento | "Project Proposal" |
| Soggetto | String | Oggetto del documento | "Q1 2024 Planning" |
| Parole chiave | String | Parole chiave del documento (separate da virgole) | "planning, budget, strategy" |
| Commenti | String | commenti al documento | "Draft version for review" |
| Categoria | String | Categoria del documento | "Business" |
| Azienda | String | Nome dell'azienda | "Acme Corporation" |
| Manager | String | Nome del manager | "Jane Smith" |
| Creato | String | Data e ora di creazione del documento (formattato) | "1/15/2024 10:30:00 AM" |
| Ultima modifica | String | Data e ora dell'ultimo salvataggio (formattato) | "1/20/2024 2:45:00 PM" |
| Ultima stampa | String | Data e ora dell'ultima stampa (formattata) | "1/18/2024 9:15:00 AM" |
| Numero di revisione | Integer | Numero di revisione del documento | 3 |
| Tempo totale di modifica | Integer | Tempo totale di modifica in minuti | 120 |
Statistiche del documento
| Nome della proprietà | Tipo | Descrizione | Esempio |
|---|---|---|---|
| Pagine | Integer | Numero totale di pagine | 8 |
| Parole | Integer | Conteggio totale delle parole | 2150 |
| Caratteri | Integer | Conteggio totale dei caratteri | 12800 |
| Paragrafi | Integer | Conteggio totale dei paragrafi | 45 |
Proprietà personalizzate
Le proprietà personalizzate sono precedute dal prefisso Custom_ nella risposta:
Custom_Department- Proprietà del dipartimento doganaleCustom_ProjectCode- Proprietà del codice progetto personalizzatoCustom_Confidential- Livello di riservatezza personalizzato- Qualsiasi altra proprietà personalizzata definita nel documento Word
Esempi di cultura supportata
| Codice culturale | Descrizione | Esempio di formato data |
|---|---|---|
en-US | Inglese (Stati Uniti) | "15/01/2024 10:30:00 AM" |
en-GB | Inglese (Regno Unito) | "15/01/2024 10:30:00" |
de-DE | Tedesco (Germania) | "15.01.2024 10:30:00" |
fr-FR | Francese (Francia) | "15/01/2024 10:30:00" |
es-ES | Spagnolo (Spagna) | "15/01/2024 10:30:00" |
ja-JP | Giapponese (Giappone) | "2024/01/15 10:30:00" |
Esempio di richiesta
Intestazione
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota:
- Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
- IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
- Esempio: se il tuo API la chiave è
abc123, codificalo in Base64 e utilizzareAuthorization: Basic YWJjMTIz
Carico utile
Esempio di base (solo campi obbligatori):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}
Esempio avanzato (con campi opzionali):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"cultureName": "en-US"
}
Esempi di codice
IL PDF4me Estrai metadati da Word REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Campione
Java implementazione con gestione completa degli errori ed elaborazione delle risposte:
JavaScript Campione
Node.js e compatibile con i browser JavaScript implementazione:
Google Script Campione
Google Apps Script implementazione per Google Workspace integrazione:
Casi d'uso e applicazioni industriali
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casi d'uso per servizi legali e professionali
- Classificazione dei documentiClassificare i documenti legali in base al tipo di caso, al cliente o all'area di specializzazione.
- Monitoraggio della conformità: Monitorare le date di creazione dei documenti e la cronologia delle revisioni per garantire la conformità normativa.
- Gestione della documentazione del cliente: Traccia le proprietà dei documenti per l'organizzazione dei file del client
- Manutenzione del registro di controllo: Metadati del documento di registro per i requisiti di audit legale
Casi d'uso aziendali e per le imprese
- Gestione delle proposteEstrazione di metadati dalle proposte per il monitoraggio e l'analisi dei clienti.
- Organizzazione del materiale di marketingClassificare i documenti di marketing in base alla campagna e al pubblico di destinazione.
- Analisi delle prestazioni dei contenuti: Analizzare le statistiche dei documenti per ottimizzare i contenuti
- Monitoraggio delle consegne al cliente: Monitorare le proprietà dei documenti per la gestione dei progetti dei clienti
Casi d'uso in ambito educativo e di ricerca.
- Classificazione dei documenti mediciClassificare i documenti medici per paziente, procedura o reparto.
- Documentazione di ricercaEstrazione di metadati da documenti di ricerca per il monitoraggio degli studi
- Cartelle cliniche e dati clinici: Organizzare documenti accademici e clinici in base alle proprietà dei metadati
- Conformità ed etica: Monitorare i metadati dei documenti per la conformità normativa in ambito sanitario e di ricerca
Casi d'uso in ambito finanziario e bancario
- Analisi del bilancioEstrazione di metadati dai report finanziari per il monitoraggio della conformità
- Gestione dei documenti di bilancioClassificare i documenti di bilancio per dipartimento e anno fiscale.
- Documentazione di audit: Traccia le proprietà del documento per la manutenzione della traccia di controllo
- Deposito regolamentare: Monitorare i metadati dei documenti per i requisiti di presentazione normativa