Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Inhaltsverzeichnis aktualisieren - TOC Management API

PDF4me Inhaltsverzeichnis aktualisieren Ermöglicht das Aktualisieren oder Erstellen von Inhaltsverzeichnissen in Word-Dokumenten mit umfassenden Formatierungsoptionen und professionellen Gestaltungsmöglichkeiten. API Der Dienst verarbeitet Word-Dateien und generiert TOCs mit automatischer Erkennung vorhandener TOC Felder, anpassbare Überschriftenebenen, Hyperlink-Unterstützung, Tabulator-Führungszeichensteuerung, Optionen für Groß- und Kleinschreibung sowie Kulturlokalisierung. API empfängt Word-Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Übertragung. Mit voller Kontrolle über TOC Diese Lösung überzeugt durch ihr ansprechendes Erscheinungsbild und ihre Funktionalität und eignet sich ideal für die Dokumentennavigation, die professionelle Formatierung und die Automatisierung. TOC Generierungs-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​

  • Automatisch TOC Detektion: Findet und aktualisiert bestehende TOC Felder oder erstellt neue
  • Anpassbare Überschriftenebenen: Festlegen, welche Überschriftenebenen (1-6) einbezogen werden sollen
  • Hyperlink-Unterstützung: Klickbare Links im TOC
  • Tab-Leader-SteuerungPunkte zwischen Text und Seitenzahlen ein- oder ausblenden
  • Optionen für Groß- und Kleinschreibung: Großbuchstaben verwenden oder Original-Groß-/Kleinschreibung beibehalten
  • KulturlokalisierungUnterstützung für verschiedene Sprachen und Regionen
  • Professionelle FormatierungAutomatische Anwendung von professionellen TOC Styling
  • SeitenzahlenintegrationAutomatische Seitenzahlenberechnung und -aktualisierung

REST API Endpunkt​

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

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

REST API Parameter​

Vollständige Liste der Parameter für die Aktualisierung des Inhaltsverzeichnisses REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.

Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind Pflichtfelder. Erweiterte Parameter ermöglichen eine detaillierte Steuerung über TOC Formatierung und Erscheinungsbild.

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
dokumentieren*ObjectDokumentenreferenz. Muss enthalten Name (string): Word-Dateiname mit der Erweiterung .docx{ "Name": "document.docx" }
docContent*Base64Word-Dokumentinhalt kodiert in Base64Die TOC Wird aus den Überschriften dieses Dokuments generiert. Muss ein gültiges Word-Dokument sein (Formate: .docx, .doc).UEsDBBQABgAIAAAA...

Optionale Parameter​

ParameterTypBeschreibungBeispiel
Überschrift EbenenStringÜberschriftenebenen, die einbezogen werden sollen TOCBereichsformat: „1–3“ (einschließlich Überschriftenebenen 1, 2 und 3). Einzelne Ebene: „1“. Mehrere Bereiche: „1–2, 4–6“. Standard: „1–3“. Entspricht den in Word integrierten Überschriftenformaten. Durchsucht das Dokument nach vorhandenen Überschriften. TOC Felder. Erstellt neue TOC am Dokumentanfang, falls kein Dokument existiert"1-3"
Hyperlinks verwendenBooleanFügen Sie Hyperlinks in das Inhaltsverzeichnis ein. true = TOC Einträge sind anklickbare Links (Standardeinstellung). false = Klartexttrue
Tab-Leiter ausblendenBooleanTabulator-Führungspunkte ausblenden. true = Keine Punkte zwischen Text und Seitenzahlen (Standardeinstellung), false = Punkte zwischen Text und Seitenzahlentrue
Großbuchstaben verwendenBooleanVerwenden Sie Großbuchstaben für TOC Einträge. true = TOC Einträge in Großbuchstaben (Standard), false = Originalfalltrue
KulturnameStringKulturcode für die Dokumentenverarbeitung (z. B. „en-US“, „de-DE“, „fr-FR“). Standardwert: null. Beeinflusst die Dokumentsprache und -formatierung.en-US

TOC Generationsverhalten​

  • Vorhanden TOC Detektion: Durchsucht das Dokument nach vorhandenen TOC Felder (FieldType.FieldTOCund aktualisiert sie
  • Neu TOC SchöpfungFalls nein TOC existiert, erschafft Neues TOC am Dokumentenanfang
  • Kursebenen-Zuordnung: Entspricht den in Word integrierten Überschriftenformaten (Überschrift 1, Überschrift 2 usw.)
  • FeldaktualisierungenAktualisiert Felder mehrfach, um die Genauigkeit zu gewährleisten.
  • SeitenlayoutRuft nacheinander UpdateFields() und UpdatePageLayout() auf.

Ausgabe​

Der PDF4me Inhaltsverzeichnis aktualisieren 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": "document.docx",
"success": true,
"errorMessage": null
}

Antwortfelder:

  • dokumentieren (string): Das Word-Dokument mit aktualisiertem Inhaltsverzeichnis, kodiert als Base64 Zeichenkette
  • Dateiname (string): Der Name der ausgegebenen Word-Datei
  • 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. 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 (Standardeinstellungen):

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

Erweitertes Beispiel (mit allen Optionen):

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-4",
 "useHyperlinks": true,
 "hideTabLeader": false,
 "useUppercase": false,
 "cultureName": "en-US"
}

Beispiel einer wissenschaftlichen Arbeit:

{
 "document": { "Name": "research-paper.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-3",
 "useHyperlinks": true,
 "hideTabLeader": true,
 "useUppercase": true
}

Codebeispiele​

Der PDF4me Inhaltsverzeichnis aktualisieren 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 Aktualisieren des Inhaltsverzeichnisses in Word-Dokumenten:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

  • Vertragsnavigation: Erstellung eines detaillierten Inhaltsverzeichnisses für komplexe Verträge
  • Rechtsgutachten: Generierung einer navigierbaren Struktur für Gerichtsdokumente
  • Compliance-Handbücher: Index regulatorische Anforderungen und Verfahren
  • Falldokumentation: Beweise und juristische Argumente organisieren

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started