Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Dokumente vergleichen – Dokumentenvergleich API

PDF4me Dokumente vergleichen Ermöglicht den Vergleich zweier Word-Dokumente und die Nachverfolgung von Änderungen mit umfassenden Vergleichsoptionen. API Der Dienst verarbeitet zwei Word-Dateien und erstellt ein Vergleichsdokument mit detaillierter Änderungsverfolgung, anpassbaren Vergleichseinstellungen, Revisionsverwaltung und professionellen Vergleichsberichten. API empfängt beide Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Sichere Verschlüsselung für die Übertragung. Dank vollständiger Kontrolle über Formatierung, Groß-/Kleinschreibung, Kommentare, Tabellen, Felder, Fußnoten, Textfelder und Kopf-/Fußzeilen eignet sich diese Lösung ideal für Dokumentenprüfung, Versionskontrolle und kollaborative Bearbeitungsprozesse.

Verwandte Blog-Beiträge
Zu dieser Funktion gibt es noch keinen Blogbeitrag – folgt in Kürze.
Schauen Sie sich in der Zwischenzeit im PDF4me-Blog Tutorials und Arbeitsabläufe für alle Plattformen an.
Besuchen Sie den Blog →

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

Get your api Key

Hauptmerkmale​

  • DokumentenvergleichVergleiche zwei Word-Dokumente und identifiziere alle Unterschiede.
  • Änderungen nachverfolgen: Dokumente mit nachverfolgten Änderungen generieren, die die Modifikationen anzeigen
  • Anpassbare Optionen: Festlegen, welche Arten von Änderungen verfolgt oder ignoriert werden sollen.
  • Revisionsverwaltung: Vor dem Vergleich bestehende Revisionen bereinigen.
  • AutorenangabeÄnderungen bestimmten Autoren zur besseren Nachvollziehbarkeit zuweisen
  • Professionelle Leistung: Erstellung übersichtlicher Vergleichsdokumente mit Revisionsverfolgung
  • Unterstützung mehrerer Formate: Vergleichen Sie .docx- und .doc-Dateien
  • Erweiterte FilterungFormatierung, Groß-/Kleinschreibung, Kommentare, Tabellen usw. ignorieren

REST API Endpunkt​

Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Dokumentenvergleichsoperationen werden über einen einzigen Endpunkt durchgeführt:

  • Verfahren: POST
  • Endpunkt: office/ApiV2Word/CompareDocuments

REST API Parameter​

Vollständige Liste der Parameter für den Dokumentenvergleich REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.

Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind erforderlich und müssen angegeben werden. API um ordnungsgemäß zu funktionieren.

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
erstes Dokument*ObjectReferenz zum ersten (Basis-)Dokument. Muss enthalten Name (Zeichenkette): Dokumentname mit Dateiendung (.docx, .doc). Dieses Dokument dient als Vergleichsgrundlage.{ "Name": "original.docx" }
ersterDokumentinhalt*Base64Base64Der Inhalt des ersten Dokuments muss kodiert sein. Es muss sich um ein gültiges Word-Dokument handeln (Formate: .docx, .doc).UEsDBBQABgAIAAAA...
zweites Dokument*ObjectZweiter (Vergleichs-)Dokumentverweis. Muss enthalten Name (Zeichenkette): Dokumentname mit Dateiendung (.docx, .doc). Dieses Dokument wird mit dem ersten verglichen.{ "Name": "modified.docx" }
zweiterDokumentinhalt*Base64Base64Der Inhalt des zweiten Dokuments muss kodiert sein. Es muss sich um ein gültiges Word-Dokument handeln (Formate: .docx, .doc).UEsDBBQABgAIAAAA...

Optionale Parameter (Vergleichsoptionen)​

ParameterTypBeschreibungBeispiel
VergleichsoptionenObjectVergleichseinstellungen. Eigenschaften: Formatierung ignorieren (boolesch), Groß-/Kleinschreibung ignorieren (boolesch), Kommentare ignorieren (boolesch), Tabellen ignorieren (boolesch), ignorierenFelder (boolesch), Fußnoten ignorieren (boolesch), Textfelder ignorieren (boolesch), ignorierenHeader und Fußzeilen (boolesch), Autor (Zeichenkette). Siehe Vergleichsoptionen unten.{ "ignoreFormatting": false, "author": "John Doe" }

Vergleichsoptionen​

Der API ermöglicht eine detaillierte Kontrolle darüber, welche Änderungen verfolgt werden sollen:

Inhaltsoptionen:​

  • Formatierung ignorierenKonzentriere dich auf den Textinhalt, ignoriere Formatierungsänderungen.
  • Groß-/Kleinschreibung ignorieren: Groß-/Kleinschreibung ignorierender Vergleich
  • Kommentare ignorierenKommentaränderungen vom Vergleich ausschließen
  • Tabellen ignorierenÄnderungen an Tabellenstruktur und -inhalt ausschließen
  • ignorierenFelder: Feldaktualisierungen ausschließen (automatische Inhaltsaktualisierung)

Dokumentelementoptionen:​

  • Fußnoten ignorierenFußnotenänderungen ausschließen
  • Textfelder ignorierenÄnderungen im Textfeld ausschließen
  • ignorierenHeader und Fußzeilen: Änderungen an Kopf- und Fußzeile ausschließen

Quellenangabe:​

  • Autor: Legen Sie den Autorennamen für die nachverfolgten Änderungen im Vergleichsdokument fest.

Ausgabe​

Der PDF4me Dokumente vergleichen 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.

Synchrone Verarbeitung (Standard)

Der API verarbeitet die Anfrage und gibt Folgendes zurück:

Statuscode: 200 OK

Inhaltstyp: application/json

Antworttext:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "comparison-result.docx",
"success": true,
"errorMessage": null
}

Antwortfelder:

  • dokumentieren (Zeichenkette): Das Word-Dokument mit nachverfolgten Änderungen, das alle Unterschiede anzeigt, kodiert als Base64 Zeichenkette
  • Dateiname (Zeichenkette): Der Name der Word-Ausgabedatei mit den Vergleichsergebnissen
  • Erfolg (Boolescher Wert): Gibt an, ob die Anfrage erfolgreich war.
  • Fehlermeldung (Zeichenkette oder null): Fehlerdetails, wenn Erfolg nicht gegeben ist

Anwendungshinweise:

  1. Extrahieren Sie die document Feld vom JSON Antwort (Base64)
  2. Entschlüsseln Sie die Base64 Zeichenkette zum Abrufen der binären Word-Dokumentdaten
  3. Öffnen Sie das Dokument in Word, um die nachverfolgten Änderungen zu überprüfen.
  4. Änderungen je nach Bedarf annehmen oder ablehnen.

Beispiel (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes - document contains tracked changes

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 verwenden Authorization: Basic YWJjMTIz

Nutzlast​

Einfaches Beispiel (nur Pflichtfelder):

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

Erweitertes Beispiel (mit Vergleichsoptionen):

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "comparisonOptions": {
 "ignoreFormatting": false,
 "ignoreCaseChanges": false,
 "ignoreComments": true,
 "ignoreTables": false,
 "ignoreFields": true,
 "ignoreFootnotes": false,
 "ignoreTextboxes": false,
 "ignoreHeadersAndFooters": false,
 "author": "Legal Review System"
 }
}

Beispiel für einen reinen Inhaltsvergleich:

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "comparisonOptions": {
 "ignoreFormatting": true,
 "ignoreCaseChanges": true,
 "ignoreComments": true,
 "ignoreFields": true,
 "author": "Content Review"
 }
}

Codebeispiele​

Der PDF4me Dokumente vergleichen REST API Es werden Codebeispiele in verschiedenen Programmiersprachen bereitgestellt. Wählen Sie die Sprache, die am besten zu Ihrer Entwicklungsumgebung passt:

C# (CSharp) Beispiel

Vollständig C# Implementierung zum Vergleichen von Word-Dokumenten:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

  • Vertragsprüfung: Vertragsversionen vergleichen, um Änderungen und Modifikationen zu identifizieren
  • Aktualisierungen von Rechtsdokumenten: Änderungen in Schriftsätzen, Vereinbarungen und Gerichtsdokumenten nachverfolgen
  • Überwachung der Einhaltung: Vergleichen Sie Richtliniendokumente, um die Einhaltung der Vorschriften sicherzustellen.
  • Prüfung von Kundendokumenten: Änderungen in kundenorientierten Rechtsdokumenten nachverfolgen

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started