Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Kopf- und Fußzeilen aktualisieren – Kopfzeilenverwaltung API

PDF4me Aktualisieren Sie Kopf- und Fußzeilen ermöglicht Ihnen das Hinzufügen oder Ändern von Kopf- und Fußzeilen in Word-Dokumenten mit umfassenden Funktionen. HTML Inhaltsunterstützung und professionelle Styling-Optionen. API Der Dienst verarbeitet Word-Dateien und wendet Kopf- und Fußzeilen auf verschiedene Seitenlayouts an, einschließlich erster Seite, gerader/ungerader Seiten und aller Seiten, wobei automatisch professionelle Standardformatierungen angewendet werden. HTML Inhaltsverarbeitung und flexible, seitenbezogene Formatierung. API empfängt Word-Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Kodierung für sichere Übertragung. Mit Unterstützung für Seitenzahlenfelder (PAGE, NUMPAGES, SECTION, SECTIONPAGES), HTML Mit Formatierungsfunktionen und automatischem professionellem Styling eignet sich diese Lösung ideal für Dokumentenbranding, Seitennummerierung und professionelle Workflows zur Dokumentenpräsentation.

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 SeitentypenUnterstützung für alle Seiten, erste Seite, gerade/ungerade Seiten
  • HTML Inhaltsunterstützung: Reich HTML Zufriedenheit mit professionellem Styling
  • Automatisches StylingProfessionelle Standardformatierung für reinen Textinhalt
  • SeitenzahlenfelderUnterstützung für PAGE, NUMPAGES, SECTION, SECTIONPAGES
  • Flexibles LayoutUnterschiedliche Kopf- und Fußzeilen für verschiedene Seitentypen
  • Kulturförderung: Lokalisierungsspezifische Dokumentenverarbeitung
  • Formaterhaltung: Behält die ursprüngliche Dokumentenstruktur bei
  • Professionelles AuftretenAutomatische Anwendung eines professionellen Stylings

REST API Endpunkt​

Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Aktualisierungsvorgänge für Kopf- und Fußzeilen werden über einen einzigen Endpunkt durchgeführt:

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

REST API Parameter​

Vollständige Liste der Parameter für die Aktualisierung von Kopf- und Fußzeilen 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 seitenbezogener Kopf- und Fußzeilen.

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
dokumentieren*ObjectDokumentenbeschreibung. Muss enthalten Name (string): Ausgabedateiname (Word-Datei) mit der Erweiterung .docx{ "Name": "document.docx" }
docContent*Base64Word-Dokumentinhalt kodiert in Base64Diesem Dokument wurden Kopf- und Fußzeilen hinzugefügt. Es muss sich um ein gültiges Word-Dokument handeln (Formate: .docx, .doc).base64EncodedDocumentContent

Optionale Parameter (Kopf-/Fußzeile) HTML)​

ParameterTypBeschreibungBeispiel
headerContentStringEinfacher Header-Inhalt (wird zusammen mit footerContent verwendet, wenn das isHtml/isHtmlMode-Steuerungsformat verwendet wird)"Company Name"
FußzeileninhaltStringEinfacher Fußzeileninhalt"Page PAGE of NUMPAGES"
isHtmlBooleanOb Kopf-/Fußzeileninhalte HTMLtrue
isHtmlModeBooleanVerwenden HTML Modus für die Inhaltsverarbeitungtrue
allPagesHeaderHtmlStringKopfzeile HTML Für alle Seiten. Unterstützt PAGE, NUMPAGES, SECTION, SECTIONPAGES"<div style='text-align: center;'>Company Name</div>"
firstPageHeaderHtmlStringKopfzeile HTML Nur für die erste Seite"<div style='text-align: center;'>Title Page</div>"
evenPagesHeaderHtmlStringKopfzeile HTML für geradzahlige Seiten"<div style='text-align: right;'>Book Title</div>"
oddPagesHeaderHtmlStringKopfzeile HTML für ungerade Seiten"<div style='text-align: left;'>Chapter Title</div>"
allPagesFooterHtmlStringFußzeile HTML für alle Seiten"Page PAGE of NUMPAGES"
firstPageFooterHtmlStringFußzeile HTML Nur für die erste Seite"<div style='text-align: center;'>Confidential</div>"
evenPagesFooterHtmlStringFußzeile HTML für gerade Seiten"<div style='text-align: center;'>Page PAGE</div>"
oddPagesFooterHtmlStringFußzeile HTML für ungerade Seiten"<div style='text-align: center;'>Page PAGE</div>"

Optionale Parameter (Kopf-/Fußzeile)​

ParameterTypBeschreibungBeispiel
allPagesHeaderObjectEingegebener Header-Inhalt für alle Seiten (HeaderFooterContentInUpdate)-
erste SeitenüberschriftObjectGetippte Kopfzeile für die erste Seite-
EvenPagesHeader / ungeradeSeitenkopfzeileObjectKopfzeile für gerade/ungerade Seiten-
allPagesFooter / erste Seitenfußzeile / geraden Seitenfuß / Fußzeile der ungeraden SeitenObjectTypisierter Fußzeileninhalt pro Seitentyp-

Optionale Parameter (Allgemein)​

ParameterTypBeschreibungBeispiel
KulturnameStringKulturcode für die Dokumentenverarbeitung (z. B. „en-US“, „fr-FR“, „de-DE“). Standardwert: null. Beeinflusst die Dokumentsprache und -formatierung.en-US

HTML Inhaltsunterstützung​

Der API unterstützt HTML Inhalt aller Header- und Footer-Parameter:

  • HTML TagsStandard HTML Tags (div, span, p, b, i, u usw.)
  • CSS-Styling: Inline-CSS-Stile zur Formatierung
  • KlartextEinfacher Text erhält automatisch professionelle Standardformatierung.
  • Gemischter Inhalt: Kombinieren HTML und bei Bedarf Klartext.

Standardformatierung für reinen Text:

  • ÜberschriftenLinksbündig, untenliegender Rahmen, Schriftgröße 10px
  • FußzeilenZentrierte Ausrichtung, oberer Rahmen, 9px Schriftgröße

Seitenlayoutoptionen​

Der API Unterstützt verschiedene Seitenlayouts für Kopf- und Fußzeilen:

LayouttypBeschreibungErforderliche Parameter
Alle SeitenGleicher Kopf- und Fußbereich auf allen SeitenallPagesHeaderHtml, allPagesFooterHtml (oder getippt) allPagesHeader, allPagesFooter)
Erste SeiteUnterschiedliche Kopf- und Fußzeile auf der ersten SeitefirstPageHeaderHtml, firstPageFooterHtml (oder entsprechende maschinengeschriebene Ausdrücke)
Gerade/Ungerade SeitenUnterschiedliche Kopf- und Fußzeilen für gerade und ungerade SeitenevenPagesHeaderHtml, oddPagesHeaderHtml, evenPagesFooterHtml, oddPagesFooterHtml (oder entsprechende maschinengeschriebene Ausdrücke)

Ausgabe​

Der PDF4me Aktualisieren Sie Kopf- und Fußzeilen REST API gibt ein zurück JSON Antwort. Bei Erfolg die API gibt das Word-Dokument als Base64-kodierte Zeichenkette im document Feld (ApiV2WordApiCallRes), nicht als Binärdaten.

Erfolgsantwort

Statuscode: 200 OK

Inhaltstyp: application/json

Antworttext:

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

Antwortfelder:

  • dokumentieren (string): Das Word-Dokument mit aktualisierten Kopf- und Fußzeilen, kodiert als Base64
  • Dateiname (string): Der Name der ausgegebenen Word-Datei
  • Erfolg (boolean): Ob die Operation erfolgreich war
  • Fehlermeldung (stringFehlermeldung, falls der Erfolg nicht eintritt; andernfalls null.

Anwendungshinweise:

  1. Überprüfen successFalls zutreffend, extrahieren Sie die document Feld vom JSON Antwort
  2. Entschlüsseln Sie die Base64 Zeichenkette zum Abrufen der binären Word-Dokumentdaten
  3. Speichern oder bearbeiten Sie die Word-Datei mit fileName

Beispiel (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const base64 = data.document;
const binary = atob(base64);
const blob = new Blob([binary], { type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = data.fileName;
a.click();

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 (Kopf- und Fußzeile aller Seiten):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center;'>Company Name</div>",
 "allPagesFooterHtml": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

Fortgeschrittenes Beispiel (Erste Seite + Gerade/Ungerade Seiten):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "firstPageHeaderHtml": "<div style='text-align: center;'>Title Page</div>",
 "firstPageFooterHtml": "<div style='text-align: center;'>Confidential</div>",
 "oddPagesHeaderHtml": "<div style='text-align: left;'>Chapter Title</div>",
 "evenPagesHeaderHtml": "<div style='text-align: right;'>Book Title</div>",
 "oddPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "evenPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "cultureName": "en-US"
}

HTML-Inhaltsbeispiel:

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center; color: #333; font-size: 12px; border-bottom: 1px solid #ccc; padding-bottom: 5px;'>Company Name | Department</div>",
 "allPagesFooterHtml": "<div style='text-align: center; color: #666; font-size: 9px; border-top: 1px solid #ccc; padding-top: 5px;'>Page PAGE of NUMPAGES | © 2024 Company Name</div>",
 "cultureName": "en-US"
}

Beispiel für Klartext (Kopfzeileninhalt/Fußzeileninhalt):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "headerContent": "Company Name",
 "footerContent": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

Codebeispiele​

Der PDF4me Aktualisieren Sie Kopf- und Fußzeilen 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 von Kopf- und Fußzeilen in Word-Dokumenten:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

  • Vertragskopfzeilen: Vertraulichkeitshinweise und rechtliche Haftungsausschlüsse hinzufügen
  • Gerichtsdokumente: Fallnummern und Akteninformationen angeben
  • Rechtsgutachten: Anwaltsinformationen und Falldetails hinzufügen
  • Compliance-Berichte: Fügen Sie regulatorische Informationen und Daten hinzu.

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started