Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Dokumente zusammenführen – Dokumentenzusammenstellung API

PDF4me Dokumente zusammenführen Ermöglicht das Zusammenführen mehrerer Word-Dokumente zu einem einzigen Dokument mit erweiterten Formatierungs- und Konformitätsoptionen. API Der Dienst verarbeitet mehrere Word-Dateien und führt sie mit flexibler Dokumentreihenfolge, anpassbaren Formatierungsmodi, Einstellungen für Konformitätsstufen, Zeitzonenmetadaten und intelligenter Stilverwaltung zusammen. API empfängt Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Sichere Verschlüsselung für die Übertragung. Dank der Unterstützung für unbegrenztes Zusammenführen von Dokumenten und der vollständigen Kontrolle über das Zusammenführungsverhalten eignet sich diese Lösung ideal für die Dokumentenerstellung, Berichtskonsolidierung und Content-Management-Workflows.

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​

  • Unterstützung mehrerer Dokumente: Unbegrenzt viele Dokumente in einem zusammenführen
  • Einfache Array-StrukturBenutzerfreundliches Array Base64-kodierter Dokumentinhalt
  • Geordnete ZusammenführungDie Dokumente wurden in der Reihenfolge zusammengeführt, in der sie im Array erscheinen.
  • BasisdokumentkonzeptDas erste Dokument bildet die Grundlage für die Zusammenführung.
  • Unterstützung mehrerer FormateZusammenführen von Word-Dokumenten, PDFs und anderen unterstützten Formaten

REST API Endpunkt​

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

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

REST API Parameter​

Vollständige Liste der Parameter für die Zusammenführung von Dokumenten REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.

Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind Pflichtfelder. Unterlagen Das Array muss mindestens ein Dokument enthalten.

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
Unterlagen*ArrayArray von Dokumentobjekten, die zusammengeführt werden sollen. Muss mindestens ein Dokument enthalten. Jedes Objekt muss folgende Eigenschaften aufweisen: Dateiname (Zeichenkette) und docContent (Base64 Dokumente werden in der Reihenfolge ihres Erscheinens im Array zusammengeführt. Optionale Felder pro Dokument: Sortierposition (Ganzzahl), formatMode (Zeichenkette)[{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }]

Optionale Parameter​

ParameterTypBeschreibungBeispiel
mergeOptionsObjectZusammenführungsoptionen (Formatierung, Konformität usw.). Verfügbare Eigenschaften siehe Plugin-Modell.{}

Dokumentenzusammenführungsauftrag​

Die Dokumente werden in der Reihenfolge zusammengeführt, in der sie erscheinen. Unterlagen Array:

  • Das erste Dokument im Array wird zum Basisdokument
  • Alle nachfolgenden Dokumente sind angehängt zum Basisdokument in Array-Reihenfolge

Ausgabe​

Der PDF4me Dokumente zusammenführen 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": "merged-document.docx",
  "success": true,
  "errorMessage": null
}

Antwortfelder:

  • dokumentieren (Zeichenkette): Das zusammengeführte Word-Dokument, das alle Eingabedokumente enthält, 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:

  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. 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

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 (zwei Dokumente):

{
  "documents": [
    { "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
    { "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
  ]
}

Erweitertes Beispiel (Mehrere Dokumente mit Zusammenführungsoptionen):

{
  "documents": [
    { "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
    { "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
    { "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
  ],
  "mergeOptions": {}
}

Codebeispiele​

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

C# (CSharp) Probe

Vollständig C# Implementierung zum Zusammenführen von Word-Dokumenten:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

  • Vertragszusammenstellung: Die Vertragsabschnitte zu vollständigen Rechtsdokumenten zusammenfassen
  • Zusammenfassung von Schriftsätzen: Zusammenführung mehrerer kurzer Abschnitte zu umfassenden juristischen Schriftsätzen
  • Konformitätsdokumentation: Zusammenstellung der Compliance-Dokumente für die Einreichung bei den Aufsichtsbehörden
  • Zusammenstellung der Kundendokumente: Kundenspezifische Dokumente zu kompletten Paketen zusammenfassen

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started