Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Aufteilung des Dokuments – Dokumententeilung API

PDF4me Split-Dokument ermöglicht es Ihnen, Word-Dokumente mit flexiblen Aufteilungsoptionen und umfassender Konfigurationskontrolle in mehrere kleinere Dokumente zu unterteilen. API Der Dienst verarbeitet Word-Dateien und teilt sie nach Seiten, Abschnitten, Überschriften oder benutzerdefinierten Seitenbereichen auf, wobei die Aufteilungskriterien, die Dokumentbenennung und die Ausgabestruktur vollständig kontrolliert werden können. API empfängt Word-Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Sichere Verschlüsselung für die Übertragung. Dank Unterstützung für seitenbasierte Aufteilung, abschnittsbasierte Unterteilung, überschriftenbasierte Trennung und benutzerdefinierte Seitenbereiche eignet sich diese Lösung ideal für Dokumentenmanagement, Inhaltsverteilung und Workflow-Automatisierung.

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​

  • Mehrere Split-TypenAufgeteilt nach Seiten, Abschnitten, Überschriften oder benutzerdefinierten Bereichen
  • SeitenbereichsunterstützungAufteilung basierend auf bestimmten Seitenzahlen oder Bereichen
  • Abschnittsbasierte Aufteilung: Teilen Sie das Dokument nach jedem Word-Abschnitt auf.
  • Überschriftenbasierte Aufteilung: Das Dokument nach jeder Überschrift des angegebenen Formats teilen (z. B. Überschrift 1, Überschrift 2)
  • Flexible Konfiguration: Benutzerdefinierte Aufteilungskriterien mit dem Parameter splitConfig
  • Eindeutige DokumentennamenJedes aufgeteilte Dokument erhält einen eindeutigen GUID-Dateinamen
  • Formaterhaltung: Behält die ursprüngliche Dokumentformatierung und -struktur bei
  • Kulturförderung: Lokalisierungsspezifische Dokumentenverarbeitung

REST API Endpunkt​

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

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

REST API Parameter​

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

Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind Pflichtfelder. splitConfig Der Parameter ist erforderlich, wenn splitType ist "Array", "Anzahl der Seiten" oder "Überschriften".

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
dokumentieren*ObjectDokumentenreferenz. Muss enthalten Name (stringDateiname im Word-Format mit der Erweiterung .docx. Wird zu Referenz- und Verarbeitungszwecken verwendet.{ "Name": "document.docx" }
docContent*Base64Word-Dokumentinhalt kodiert in Base64Das Dokument wird anhand festgelegter Kriterien aufgeteilt. Es muss sich um ein gültiges Word-Dokument handeln (Formate: .docx, .doc).base64EncodedDocumentContent

Optionale Parameter​

ParameterTypBeschreibungBeispiel
SplitTypeStringArt der Dokumentenaufteilung. Optionen: allpages - Aufteilung in einzelne Seiten (Standardeinstellung), array - Aufgeteilt nach expliziten Seitenbereichen (z. B. „1-3, 4, 5-7“), numberofpages - Aufteilung nach jeweils N Seiten (Konfiguration: positive Ganzzahl wie "3" oder "5"), section - Teilen Sie das Dokument nach jedem Abschnitt auf, headings - Teilen Sie das Dokument nach jeder Überschrift des angegebenen Formats (z. B. „Überschrift 1“). Jedes Teildokument erhält eine eindeutige GUID Dateiname"allpages"
splitConfigStringKonfiguration für die Aufteilung. Für Array: Seitenbereiche wie "1-3,4,5-7" (Seiten 1-3, Seite 4, Seiten 5-7) oder einzelne Seiten "1,3,5". Für die Anzahl der SeitenEine positive ganze Zahl wie "3" oder "5": wird nach jeweils N Seiten aufgeteilt. Für ÜberschriftenÜberschriftenstilname wie „Überschrift 1“ oder „Überschrift 2“. Erforderlich, wenn splitType auf „array“, „numberofpages“ oder „headings“ gesetzt ist. Die Seitenzahlen beginnen bei 1. Bei der Überschriftenzuordnung wird nicht zwischen Groß- und Kleinschreibung unterschieden."1-3,4,5-7" oder "3" oder "Heading 1"
KulturnameStringKulturcode für die Dokumentenverarbeitung (z. B. „en-US“, „de-DE“, „fr-FR“). Standard: „en-US“. Beeinflusst die Dokumentsprache und -formatierung. Wird für Metadaten und Lokalisierung verwendet.en-US

Optionen für geteilte Typen​

Der API bietet verschiedene Aufteilungstypen für die Dokumententeilung:

Split-TypBeschreibungErfordert splitConfigAnwendungsfall
allpagesAufteilung in einzelne Seiten (Standard)NEINJede Seite als separates Dokument extrahieren
arrayAufgeteilt nach expliziten Seitenbereichen. Jeder durch Kommas getrennte Bereich wird zu einem Dokument (z. B. "1-3,4,5-7" → 3 Dokumente).JaErstellen Sie Dokumente aus bestimmten Seitenbereichen oder einzelnen Seiten.
numberofpagesAufteilung nach jeweils N Seiten. Sequenzielle Aufteilung: Jeweils N Seiten bilden ein Dokument; der Rest ist das letzte Dokument.JaIn gleich große Abschnitte unterteilen (z. B. alle 3 oder 5 Seiten).
sectionTeilen Sie das Dokument nach jedem Word-Abschnitt auf.NEINEin Dokument pro Abschnitt
headingsTeilen Sie das Dokument nach jeder Überschrift des angegebenen Formats (z. B. „Überschrift 1“).JaKapitel oder Teile nach Überschriftenebene extrahieren

Beispiele für geteilte Konfigurationen​

Das Verständnis der Split-Konfiguration hilft Ihnen, Ihre Workflows zur Dokumentenaufteilung zu optimieren:

array: explizite Seitenbereiche​

  • "1-3,4,5-7" → 3 Dokumente: Seiten 1-3, Seite 4, Seiten 5-7
  • "1,3,5" → 3 Dokumente: Seite 1, Seite 3, Seite 5
  • "1-5,6-10" → 2 Dokumente: Seiten 1-5, Seiten 6-10

numberofpages: Aufteilung nach jeweils N Seiten​

Verhalten: Teilt sich nach jeweils N Seiten sequenziell auf. Konfiguration: Erforderliches Format: eine einzelne positive ganze Zahl (z.B. "3", "5").

Beispiele:

  • Konfiguration "3" Aufteilung eines 10-seitigen Dokuments in 4 Dokumente: Dokument 1: Seiten 1–3, Dokument 2: Seiten 4–6, Dokument 3: Seiten 7–9, Dokument 4: Seite 10
  • Konfiguration "5" Aufteilung eines 12-seitigen Dokuments in 3 Dokumente: Dokument 1: Seiten 1–5, Dokument 2: Seiten 6–10, Dokument 3: Seiten 11–12

headings: Aufteilung nach jeder Überschrift​

  • "Heading 1", ein Dokument pro Block, der mit der nächsten Überschrift 1 (oder dem Dokumentenende) endet
  • "Heading 2", ein Dokument pro Block, der mit der nächsten Überschrift 2 (oder dem Dokumentenende) endet
  • Groß-/Kleinschreibung ignorierende Übereinstimmung

section​

Keine Konfiguration erforderlich. Das Dokument wird nach jedem Word-Abschnittsumbruch geteilt; jeder Abschnitt wird zu einem eigenen Dokument.

Ausgabe​

Der PDF4me Split-Dokument REST API gibt das Split-Ergebnis zurück als JSON. Der API Gibt ein einzelnes Dokument in der Antwort zurück (das erste aufgeteilte Dokument) mit Standardantwortfeldern.

Synchrone Verarbeitung (Standard)

Der API verarbeitet die Anfrage und gibt das erste aufgeteilte Dokument zurück:

Statuscode: 200 OK

Inhaltstyp: application/json

Antworttext:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx",
"success": true,
"errorMessage": null
}

Antwortfelder:

  • dokumentieren (string): Der erste aufgeteilte Dokumentinhalt, kodiert als Base64 Zeichenkette
  • Dateiname (string): Generierter Dateiname für das aufgeteilte Dokument (GUID-basierend)
  • Erfolg (boolean): Gibt an, ob die Anfrage erfolgreich war.
  • Fehlermeldung (string 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. Verwenden Sie die fileName um das geteilte Dokument zu speichern

Beispiel (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save with data.fileName or custom name

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 (Alle Seiten aufteilen - Standard):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "splitType": "allpages"
}

Beispiel für einen Seitenbereich (Array):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "splitType": "array",
 "splitConfig": "1-3,4,5-7"
}

Aufteilung nach jeweils N Seiten (Anzahl der Seiten):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "splitType": "numberofpages",
 "splitConfig": "3"
}

Beispiel basierend auf Überschriften (nach jeder Überschrift aufgeteilt):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "splitType": "headings",
 "splitConfig": "Heading 1",
 "cultureName": "en-US"
}

Abschnittsbasiertes Beispiel (Aufteilung nach jedem Abschnitt):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "splitType": "section",
 "cultureName": "en-US"
}

Codebeispiele​

Der PDF4me Split-Dokument 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 Aufteilen von Word-Dokumenten:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

  • Vertragsmanagement: Aufteilung von Mehrparteienverträgen in einzelne Abschnitte
  • Falldokumentation: Bestimmte Seiten aus Fallakten extrahieren
  • Compliance-Berichte: Relevante Abschnitte an verschiedene Abteilungen verteilen
  • Rechtsrecherche: Große juristische Dokumente nach Thema oder Abschnitt aufteilen

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started