Ottimizzazione del documento - Ottimizzazione del documento API
PDF4me Ottimizza il documento consente di ottimizzare i documenti Word in termini di dimensioni e prestazioni con tre diversi livelli di compressione e tecniche di ottimizzazione complete. API Il servizio elabora i file Word e riduce le dimensioni dei file, comprime le immagini, pulisce il contenuto, normalizza la formattazione e rimuove le informazioni personali. API riceve il contenuto del documento Word tramite REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Grazie al supporto di livelli di ottimizzazione Basso, Medio e Alto, che consentono una riduzione delle dimensioni dei file dallo 0% al 90%, questa soluzione è ideale per la preparazione dei documenti, l'ottimizzazione dello storage e i flussi di lavoro per il miglioramento delle prestazioni.
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
- Massima ottimizzazioneProfilo di compressione massimo per la massima riduzione delle dimensioni del file
- Riduzione delle dimensioni del file: Ottieni una riduzione delle dimensioni dei file dell'80-90% con l'ottimizzazione massima
- Compressione dell'immagineOttimizzazione intelligente dell'immagine con preservazione della qualità
- Pulizia dei contenuti: Rimuovi macro, commenti e contenuti nascosti non utilizzati.
- Formattazione Normalizzazione: Elimina la formattazione ridondante e gli stili non utilizzati
- Rimozione delle informazioni personali: Rimuovi le informazioni su autore, responsabile e azienda
- Ottimizzazione dei caratteriNormalizza i caratteri e rimuovi le proprietà dei caratteri non necessarie
- Miglioramento della compatibilitàOttimizza i documenti per la compatibilità con Word 2016
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di ottimizzazione dei documenti vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
office/ApiV2Word/OptimizeDocument
REST API Parametri
Elenco completo dei parametri per l'ottimizzazione del documento REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori. Il livello di ottimizzazione determina l'aggressività delle tecniche di ottimizzazione applicate.
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 Base64Il documento originale non è stato modificato: è stata creata una nuova versione ottimizzata. | UEsDBBQABgAIAAAA... |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| Livello di ottimizzazione | String | Livello di ottimizzazione (ad esempio Basso, Medio, Massimo). Massimo - Compressione massima (~80-90%). Controlla l'aggressività delle tecniche di ottimizzazione. | "Max" |
| wordVersion | String | Versione di Word di destinazione per la compatibilità | null |
| Nome della cultura | String | Codice culturale per l'elaborazione dei documenti (ad esempio, "en-US", "de-DE", "fr-FR") | en-US |
Profilo di ottimizzazione
IL Massimo Il profilo di ottimizzazione garantisce la massima compressione:
- Riduzione delle dimensioni del file: 80-90%
- Qualità dell'immagine: Ottimizzato per le dimensioni
- Formattazione: Pulizia aggressiva
- Commenti: RIMOSSO
- Revisioni: RIMOSSO
- Informazioni personali: RIMOSSO
- Macro: RIMOSSO
- Stili non utilizzati: RIMOSSO
- Contenuto nascosto: RIMOSSO
Produzione
IL PDF4me Ottimizza il documento REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il documento Word come un Base64-stringa codificata in JSON formato, 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": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
Campi di risposta:
- documento (stringa): Il documento Word ottimizzato con dimensioni del file ridotte, codificato come Base64 corda
- Nome file (stringa): Il nome del file Word di output
- successo (booleano): Indica se la richiesta è andata a buon fine
- messaggio di errore (stringa o null): Dettagli dell'errore quando il successo è falso
Come si usa:
- Estrarre il
documentcampo dal JSON risposta (Base64) - decodificare il Base64 stringa per ottenere i dati binari del documento Word
- Salva o elabora il file Word secondo necessità.
Esempio (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
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 struttura di risposta (documento, nomefile, successo, messaggiodierrore).
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
- Livello di ottimizzazione non valido
- 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 di ottimizzazione del documento
- Errore durante l'applicazione delle impostazioni di compressione
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSON, mai dati Word binari direttamente.
Struttura della risposta:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
Intestazione Content-Type:
- Successo:
application/json - Il documento Word è incorporato come Base64 stringa all'interno della JSON risposta
Perché Base64?
- JSON- codifica sicura per dati binari
- Facile da trasmettere HTTP
- Compatibile con tutti i linguaggi di programmazione
- Può essere incorporato direttamente in JSON senza sfuggire ai problemi
Codifica Base64 al documento 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);
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 base (ottimizzazione massima predefinita):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max"
}
Esempio avanzato (con campi opzionali):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max",
"wordVersion": null,
"cultureName": "en-US"
}
Esempi di codice
IL PDF4me Ottimizza il documento 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
C# CSharp) Campione
Completo C# Implementazione per l'ottimizzazione dei documenti Word:
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
- Distribuzione dei documentiOttimizzazione dei documenti legali per la distribuzione ai clienti.
- Deposito pubblico: Preparare i documenti per il deposito pubblico in tribunale
- ArchiviazioneOttimizzare i documenti legali per l'archiviazione a lungo termine.
- Documenti di conformità: Ripulire la documentazione per le presentazioni agli enti regolatori
Casi d'uso aziendali e per le imprese
- Distribuzione delle proposte: Ottimizzare le proposte per la consegna al cliente
- Condivisione di materiale di marketingOttimizzare i documenti di marketing per la distribuzione al pubblico.
- Ottimizzazione della presentazioneOttimizza le presentazioni per la distribuzione via email.
- Preparazione dei documenti da consegnare al cliente: Ripulire la documentazione per la consegna al cliente
Casi d'uso in ambito educativo e di ricerca.
- Distribuzione del referto del pazienteOttimizzazione dei referti medici per una condivisione sicura.
- Documentazione di ricercaOttimizzare i documenti di ricerca per la pubblicazione.
- Protocollo di condivisioneOttimizzazione dei protocolli medici per la distribuzione nei vari reparti.
- Documentazione di conformità: Ripulire la documentazione per le presentazioni agli enti regolatori
Casi d'uso in ambito finanziario e bancario
- Distribuzione del bilancioOttimizzazione dei report finanziari per la distribuzione agli stakeholder
- Documentazione di audit: Ripulire i documenti di audit per la condivisione esterna
- Condivisione dei documenti di bilancioOttimizzare i documenti di bilancio per la distribuzione ai vari dipartimenti.
- Deposito regolamentare: Preparare la documentazione per le presentazioni agli enti regolatori