Dokument optimieren – Dokumentenoptimierung API
PDF4me Dokument optimieren ermöglicht es Ihnen, Word-Dokumente hinsichtlich Größe und Leistung mit drei verschiedenen Komprimierungsstufen und umfassenden Optimierungstechniken zu optimieren. API Der Dienst verarbeitet Word-Dateien und reduziert die Dateigröße, komprimiert Bilder, bereinigt Inhalte, normalisiert die Formatierung und entfernt persönliche Informationen. API empfängt Word-Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Übertragung. Dank der Unterstützung von niedrigen, mittleren und hohen Optimierungsstufen, die eine Dateigrößenreduzierung von 0–90 % ermöglichen, eignet sich diese Lösung ideal für die Dokumentenerstellung, Speicheroptimierung und Leistungsverbesserung von Arbeitsabläufen.
Authentifizierung Ihres API Anfrage
Um auf die PDF4me REST APIJede Anfrage muss die entsprechenden Authentifizierungsdaten enthalten. Die Authentifizierung gewährleistet eine sichere Kommunikation und bestätigt Ihre Identität als autorisierter Benutzer des Systems. REST APIDie
Hauptmerkmale
- Maximale Optimierung: Maximales Komprimierungsprofil für maximale Dateigrößenreduzierung
- Dateigrößenreduzierung: Erzielen Sie mit Max-Optimierung eine Dateigrößenreduzierung von 80-90%.
- BildkomprimierungIntelligente Bildoptimierung mit Qualitätserhalt
- Inhaltsbereinigung: Entfernt ungenutzte Makros, Kommentare und versteckte Inhalte
- Formatierung Normalisierung: Überflüssige Formatierungen und ungenutzte Stile entfernen
- Entfernung persönlicher Daten: Informationen zu Autor, Manager und Unternehmen entfernen
- Schriftartoptimierung: Schriftarten normalisieren und unnötige Schrifteigenschaften entfernen
- KompatibilitätsverbesserungDokumente für die Kompatibilität mit Word 2016 optimieren
REST API Endpunkt
Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Dokumentoptimierungsoperationen werden über einen einzigen Endpunkt durchgeführt:
- Verfahren: POST
- Endpunkt:
office/ApiV2Word/OptimizeDocument
REST API Parameter
Vollständige Liste der Parameter für das Optimierungsdokument REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.
Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind Pflichtfelder. Der Optimierungsgrad bestimmt die Intensität der angewandten Optimierungstechniken.
Erforderliche Parameter
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| dokumentieren* | Object | Dokumentenreferenz. Muss enthalten Name (Zeichenkette): Name der Word-Datei mit der Dateiendung .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Word-Dokumentinhalt kodiert in Base64Das Originaldokument wurde nicht verändert – eine neue, optimierte Version wurde erstellt. | UEsDBBQABgAIAAAA... |
Optionale Parameter
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| Optimierungsstufe | String | Optimierungsstufe (z. B. Niedrig, Mittel, Maximal). Max - Maximale Kompression (~80–90 %). Steuert die Aggressivität der Optimierungstechniken. | "Max" |
| wordVersion | String | Ziel-Word-Version für Kompatibilität | null |
| Kulturname | String | Kulturcode für die Dokumentenverarbeitung (z. B. „en-US“, „de-DE“, „fr-FR“) | en-US |
Optimierungsprofil
Der Max Das Optimierungsprofil sorgt für maximale Komprimierung:
- Dateigrößenreduzierung80-90%
- Bildqualität: Optimiert für Größe
- FormatierungAggressive Aufräumarbeiten
- Kommentare: ENTFERNT
- Überarbeitungen: ENTFERNT
- Persönliche Daten: ENTFERNT
- Makros: ENTFERNT
- Unbenutzte Stile: ENTFERNT
- Versteckter Inhalt: ENTFERNT
Ausgabe
Der PDF4me Dokument optimieren REST API Die Antwort hängt vom Verarbeitungsmodus ab. API gibt das Word-Dokument als Base64-kodierte Zeichenkette in JSON Format, nicht als Binärdaten.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Synchrone Verarbeitung (Standard)
Der API verarbeitet die Anfrage und gibt Folgendes zurück:
Statuscode: 200 OK
Inhaltstyp: application/json
Antworttext:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
Antwortfelder:
- dokumentieren (Zeichenkette): Das optimierte Word-Dokument mit reduzierter Dateigröße, kodiert als Base64 Zeichenkette
- Dateiname (Zeichenkette): Der Name der Word-Ausgabedatei
- Erfolg (Boolescher Wert): Gibt an, ob die Anfrage erfolgreich war.
- Fehlermeldung (Zeichenkette oder null): Fehlerdetails, wenn Erfolg nicht gegeben ist
Anwendungshinweise:
- Extrahieren Sie die
documentFeld vom JSON Antwort (Base64) - Entschlüsseln Sie die Base64 Zeichenkette zum Abrufen der binären Word-Dokumentdaten
- Speichern oder bearbeiten Sie die Word-Datei nach Bedarf.
Beispiel (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
Asynchrone Verarbeitung
Asynchrones Verhalten (202 Accepted (mit Polling) wird durch die Serverkonfiguration gesteuert, nicht durch einen Parameter im Anfragetext. Wenn aktiviert, API kann bei einer Abfrage den Statuscode 202 zurückgeben. URL im Location Überschrift. Fragen Sie die URL mit GET Stellen Sie so lange Anfragen, bis Sie 200 erhalten. OK mit der gleichen Antwortstruktur (Dokument, Dateiname, Erfolgsmeldung, Fehlermeldung).
Fehlermeldungen
Der API Standard-Rückgabe HTTP Fehlercodes mit Fehlerdetails:
- Ungültige Anfrageparameter
- Fehlende Pflichtfelder (
dokumentierenmitName,docContent) - Ungültig Base64 Kodierung in
docContent - Ungültiges oder beschädigtes Word-Dokument
- Ungültige Optimierungsstufe
- Ungültig oder fehlend API Schlüssel
- API Schlüssel nicht richtig Base64 kodiert in Authorization Überschrift
- Fehlen
Autorisierung: BasisÜberschrift
- Serverseitiger Verarbeitungsfehler
- Fehler bei der Verarbeitung des Word-Dokuments
- Fehler bei der Dokumentenoptimierung
- Fehler beim Anwenden der Komprimierungseinstellungen
Fehlerantwortformat:
{
"error": "Error message describing what went wrong"
}
Details zum Antwortformat
Wichtig: Der API kehrt immer zurück JSON, niemals direkt binäre Word-Daten.
Antwortstruktur:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
Content-Type-Header:
- Erfolg:
application/json - Das Word-Dokument ist eingebettet als Base64 Zeichenkette innerhalb der JSON Antwort
Warum Base64?
- JSON-sichere Kodierung für Binärdaten
- Einfach zu übertragen über HTTP
- Kompatibel mit allen Programmiersprachen
- Kann direkt eingebettet werden in JSON ohne den Problemen auszuweichen
Dekodierung Base64 in Word-Dokument:
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);
Beispielanfrage
Kopfzeile
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Notiz:
- Hol dir deins API Schlüssel vom PDF4me Armaturenbrett
- Der API Der Schlüssel muss sein Base64 kodiert und mit "Basic" präfixiert in der Authorization Überschrift
- Beispiel: Wenn Ihr API Schlüssel ist
abc123, kodieren Sie es zu Base64 und verwendenAuthorization: Basic YWJjMTIz
Nutzlast
Einfaches Beispiel (Standard-Maximaloptimierung):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max"
}
Erweitertes Beispiel (mit optionalen Feldern):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max",
"wordVersion": null,
"cultureName": "en-US"
}
Codebeispiele
Der PDF4me Dokument optimieren REST API Es werden Codebeispiele in verschiedenen Programmiersprachen bereitgestellt. Wählen Sie die Sprache, die am besten zu Ihrer Entwicklungsumgebung passt:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Probe
Java Implementierung mit vollständiger Fehlerbehandlung und Antwortverarbeitung:
Python Probe
Python Implementierung mit der Requests-Bibliothek und JSON Handhabung:
Google Script Probe
Google Apps Script Implementierung für Google Workspace Integration:
Branchenspezifische Anwendungsfälle und Anwendungen
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Anwendungsfälle für Rechts- und Beratungsdienstleistungen
- Dokumentenverteilung: Optimierung von Rechtsdokumenten für die Mandantenverteilung
- Öffentliche Einreichung: Dokumente für die öffentliche Einreichung bei Gericht vorbereiten
- ArchivspeicherRechtsdokumente für die Langzeitarchivierung optimieren
- Konformitätsdokumente: Dokumente für behördliche Einreichungen aufbereiten
Anwendungsfälle für Unternehmen und Organisationen
- Verteilung der Vorschläge: Optimierung von Angeboten für die Kundenauslieferung
- Weitergabe von Marketingmaterialien: Marketingdokumente für die öffentliche Verteilung optimieren
- Präsentationsoptimierung: Präsentationen für den E-Mail-Versand optimieren
- Vorbereitung der KundenleistungenDokumente für die Kundenauslieferung aufbereiten
Anwendungsfälle in Bildung und Forschung
- Verteilung von PatientenberichtenOptimieren Sie medizinische Berichte für die sichere Weitergabe.
- Forschungsdokumentation: Forschungsdokumente für die Veröffentlichung optimieren
- Protokollteilung: Optimierung der medizinischen Protokolle für die Abteilungsverteilung
- Konformitätsdokumentation: Dokumente für behördliche Einreichungen aufbereiten
Anwendungsfälle im Finanz- und Bankwesen
- Verteilung des Finanzberichts: Finanzberichte für die Verteilung an Stakeholder optimieren
- Prüfdokumentation: Prüfdokumente für die externe Weitergabe aufbereiten
- Austausch von Budgetdokumenten: Budgetdokumente für die Abteilungsverteilung optimieren
- Meldung an die Aufsichtsbehörden: Dokumente für die Einreichung bei den Aufsichtsbehörden vorbereiten