Hinzufügen HTML Kopfzeile Fußzeile zu PDF - Markenbildung API

PDF4me Hinzufügen HTML Kopfzeile Fußzeile zu PDF ermöglicht Ihnen das Hinzufügen HTML Inhalte als Kopf-, Fuß- oder beides PDF Dokumente. Diese API Serviceprozesse PDF Dateien und Hinzufügungen HTML Inhalte mit präziser Positionierung, benutzerdefinierten Rändern und Seitenausrichtungsoptionen für Dokumentenbranding und -organisation. API empfängt PDF Inhalt und HTML Daten durch REST API Anrufe, die genutzt werden Base64 sichere Kodierung PDF Übertragung. Mit Unterstützung für HTML Inhalte, flexible Positionierung, benutzerdefinierte Ränder, Seitenausrichtung und Ausschluss der ersten Seite – diese Lösung ist ideal für Dokumentenbranding, Berichtserstellung und Unternehmen. PDF Arbeitsabläufe.

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

• HTML InhaltsunterstützungReichhaltig hinzufügen HTML Inhalte als Kopf- und Fußzeilen mit vollständiger Formatierungsunterstützung
• Flexible Positionierung: Position von Kopf- und Fußzeile mit präziser Randsteuerung steuern
• Individuelles Styling: Voll HTML Und CSS Unterstützung für ein professionelles Erscheinungsbild
• Seitenausrichtung: Kopf- und Fußzeilen auf bestimmte Seiten oder ganze Dokumente anwenden
• Erste Seite überspringenOption zum Ausblenden von Kopf- und Fußzeilen auf der ersten Seite
• Professionelle Ergebnisse: Erstellen Sie Kopf- und Fußzeilen, die die Dokumentorganisation und das Branding verbessern.
• Nahtlos API Integration: REST API entwickelt für automatisierte PDF Workflow-Bearbeitung und Integration von Unternehmenssystemen

REST API Endpunkt

Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Operationen zum Hinzufügen von Kopf- und Fußzeilen werden über einen einzigen Endpunkt ausgeführt:

• Verfahren: POST
• Endpunkt: /api/v2/AddHtmlHeaderFooter

Kopf- und Fußzeilenfunktionen

HTML Inhaltsunterstützung

• HTML InhaltUnterstützung für HTML Inhalt mit Inline CSS Styling
• Individuelles Styling: Inline verwenden CSS für Schriftarten, Farben, Ausrichtung und grundlegende Formatierung
• Text und BilderUnterstützung für HTML Textinhalte und eingebettete Bilder
• Schmucklos HTML Zeichenkette: HTML Der Inhalt muss als einfacher String angegeben werden (nicht Base64 kodiert)

Positionierung und Layout

• Margenkontrolle: Präzise Positionierung mit pixelbasierten Messungen (marginLeft, marginRight, marginTop, marginBottom)
• Seitenausrichtung: Auf bestimmte Seiten anwenden mithilfe von Seitenoptionen (leere Zeichenkette für alle Seiten, "1", "1,3,5", "2-5", "1,3,7-10", "2-")
• Erste Seite überspringenOption zum Ausblenden von Kopf- und Fußzeilen auf der ersten Seite
• Standortoptionen: Inhalt als Kopfzeile, Fußzeile oder beides hinzufügen

Erweiterte Funktionen

• Asynchrone VerarbeitungUnterstützung für die asynchrone Verarbeitung mit Polling für langlaufende Operationen
• Professionelles AuftretenEinheitliche Formatierung und Gestaltung in allen Dokumenten
• Flexible Positionierung: Position von Kopf- und Fußzeile mit exakten Pixelmessungen steuern.

REST API Parameter

Vollständige Liste der Parameter für die Hinzufügung HTML Kopfzeile Fußzeile zu PDF 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

Parameter	Typ	Beschreibung	Beispiel
docName*	String	Ausgabe PDF Dateiname mit der Erweiterung .pdf	output.pdf
docContent*	Base64	Der Inhalt der Eingabe PDF Datei kodiert in Base64	JVBERi...
htmlContent*	String	HTML Inhalt (einfach) HTML (Zeichenkette, NICHT Base64-kodiert), die als Kopf- oder Fußzeile hinzugefügt werden soll	<div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div>
Standort*	String	Standort für HTML Inhalt: Kopfzeile, Fußzeile, oder Beide	Header

Optionale Parameter

Parameter	Typ	Beschreibung	Beispiel
Seiten	String	Seitenoptionen: leere Zeichenkette für alle Seiten, "1" für Seite 1, "1,3,5" für bestimmte Seiten, "2-5" für Seitenbereich "1,3,7-10" für gemischte "2-" für die Seiten 2 bis Ende	"" oder "1-3"
überspringenErsteSeite	Boolean	Erste Seite überspringen (wahr) oder erste Seite einbeziehen (falsch)	false
linker Rand	Doppelt	Linker Rand in Pixeln	20.0
marginRight	Doppelt	Rechter Rand in Pixeln	20.0
marginTop	Doppelt	Oberer Rand in Pixeln	50.0
unterer Rand	Doppelt	Unterer Rand in Pixeln	50.0
asynchron	Boolean	Aktivieren Sie die asynchrone Verarbeitung. Wenn true, Die API Gibt den Statuscode 202 zurück und stellt eine Abfrage bereit. URL im Location Überschrift	true

Wichtiger Hinweis: Der htmlContent Der Parameter muss ein schmucklos HTML Zeichenkette, nicht Base64 kodiert. Sie können Inline-Einbindungen vornehmen. CSS Styling innerhalb des HTMLDie

Ausgabe

Der PDF4me Hinzufügen HTML Kopfzeile Fußzeile zu PDF REST API Die Antwort hängt vom Verarbeitungsmodus ab. API gibt zurück PDF als Base64-kodierte Zeichenkette in JSON Format, nicht als Binärdaten.

Success Response

Synchrone Verarbeitung (Standard)

Wann async ist nicht festgelegt oder auf gesetzt false, Die API verarbeitet die Anfrage sofort:

Statuscode: 200 OK

Content-Type: application/json

Antworttext:

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}

Antwortfelder:

• docName (Zeichenkette): Die Ausgabe PDF Dateiname
• docContent (Zeichenkette): Die PDF Datei mit HTML Kopf- und Fußzeile angewendet, kodiert als Base64 Zeichenkette

Anwendungshinweise:

1. Extrahieren Sie die docContent Feld vom JSON Antwort
2. Entschlüsseln Sie die Base64 Zeichenkette, um den Binärwert zu erhalten PDF Daten
3. Speichern oder verarbeiten Sie die PDF Datei nach Bedarf

Beispiel (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes

Asynchronous Processing

Asynchrone Verarbeitung

Wann async: true ist festgelegt, die API verarbeitet die Anfrage asynchron:

Statuscode: 202 Accepted

Antwort-Header:

Location: https://api.pdf4me.com/api/v2/AddHtmlHeaderFooter/poll/12345-abcde-67890

Abstimmungsverfahren:

1. Extrahieren Sie die Location Header der 202-Antwort
2. Befragen Sie die URL Verwendung GET Anfragen
3. Nehmen Sie so lange an der Umfrage teil, bis Sie eine Antwort erhalten. 200 OK Status
4. Die endgültige Antwort enthält dasselbe JSON Format mit docName Und docContent (Base64)

Umfragebeispiel:

// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');

// Poll until complete
while (true) {
  const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
  if (pollResponse.status === 200) {
    const data = await pollResponse.json();
    // Process data.docContent (Base64 PDF)
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

Fehlermeldungen

Der API Standard-Rückgabe HTTP Fehlercodes mit Fehlerdetails:

400 Bad Request

• Ungültige Anfrageparameter
• Fehlende Pflichtfelder (docName, docContent, htmlContent, Standort)
• Ungültig Base64 Kodierung in docContent
• Ungültiger Wert für den Speicherort (muss sein: Header, Footer oder Beides)
• Ungültig HTML Inhalt

401 Unauthorized

• Ungültig oder fehlend API Schlüssel
• API Schlüssel nicht richtig Base64 kodiert in Authorization Überschrift
• Fehlen Autorisierung: Basis Überschrift

500 Internal Server Error

• Serverseitiger Verarbeitungsfehler
• PDF Verarbeitungsfehler
• HTML Rendering-Fehler

Fehlerantwortformat:

{
  "error": "Error message describing what went wrong"
}

Response Format Details

Details zum Antwortformat

Wichtig: Der API kehrt immer zurück JSONniemals binär PDF Daten direkt.

Antwortstruktur:

{
  "docName": "string",      // Output PDF filename
  "docContent": "string"    // Base64-encoded PDF content
}

Content-Type Überschrift:

• Erfolg: application/json
• Der PDF ist eingebettet als Base64 Zeichenkette innerhalb der JSON Antwort

Warum Base64?

• JSON-sichere Kodierung für Binärdaten
• Einfach zu übertragen über HTTP
• Kompatibel mit allen Programmiersprachen
• Kann direkt eingebettet werden in JSON ohne den Problemen auszuweichen

Dekodierung Base64 Zu PDF:

JavaScript/Node.js:

const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js

Python:

import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
    f.write(pdf_bytes)

C#:

byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);

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):

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header"
}

Erweitertes Beispiel (mit allen optionalen Feldern):

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header",
  "pages": "",
  "skipFirstPage": false,
  "marginLeft": 20.0,
  "marginRight": 20.0,
  "marginTop": 50.0,
  "marginBottom": 50.0,
  "async": true
}

Wichtig: Der htmlContent Das Feld muss Folgendes enthalten: schmucklos HTML als Zeichenkette, nicht Base64 kodiert. Sie können Inline-Code verwenden. CSS Styling innerhalb des HTML Tags.

Codebeispiele

Der PDF4me Hinzufügen HTML Kopfzeile Fußzeile zu PDF REST API Es werden Codebeispiele in verschiedenen Programmiersprachen bereitgestellt. Wählen Sie die Sprache, die am besten zu Ihrer Entwicklungsumgebung passt:

C#

C# (CSharp) Beispiel

Vollständig C# Implementierung zum Hinzufügen von Kopf- und Fußzeilen zu PDF:

View C# Sample

Java

Java Probe

Java Implementierung mit vollständiger Fehlerbehandlung und Antwortverarbeitung:

View Java Sample

JavaScript

JavaScript Probe

Node.js und browserkompatibel JavaScript Implementierung:

View JavaScript Sample

Python

Python Probe

Python Implementierung mit der Requests-Bibliothek und JSON Handhabung:

View Python Sample

Salesforce

Salesforce Probe

Salesforce Apex Implementierung für CRM Integration:

View Salesforce Sample

n8n

n8n Probe

n8n Workflow-Implementierung für die Automatisierung:

View n8n Sample

Google Script

Google Script Probe

Google Apps Script Implementierung für Google Workspace Integration:

View Google Script Sample

AWS Lambda

AWS Lambda Probe

Serverlos AWS Lambda Funktionsimplementierung:

View AWS Lambda Sample

Branchenspezifische Anwendungsfälle und Anwendungen

Legal & Professional Services

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

• RechtsdokumentationRechtliche Haftungsausschlüsse und Vertraulichkeitshinweise auf juristische Dokumente anwenden
• Vertragskopfzeilen: Verträgen und Vereinbarungen Kopf- und Fußzeilen hinzufügen
• Konformitätsdokumentation: Fügen Sie Compliance-Hinweise in Kopf- und Fußzeilen ein
• Kundendokumentation: Fügen Sie Kundendokumenten professionelle Kopf- und Fußzeilen hinzu

Business & Enterprise

Anwendungsfälle für Unternehmen und Organisationen

• Dokumentenbranding: Firmenlogos, Kopf- und Fußzeilen zu PDF-Dokumenten hinzufügen
• Berichtserstellung: Fügen Sie den generierten Berichten einheitliche Kopf- und Fußzeilen hinzu.
• GeschäftsdokumenteVerbessern Sie Ihr professionelles Erscheinungsbild mit individuell gestalteten Kopf- und Fußzeilen.
• Corporate Branding: Einheitliche Kopf- und Fußzeilen in allen Geschäftsdokumenten verwenden

Education & Research

Anwendungsfälle in Bildung und Forschung

• Wissenschaftliche Arbeiten: Fügen Sie Seitenzahlen, Kopf- und Fußzeilen zu akademischen Publikationen hinzu.
• Forschungsdokumente: Forschungsarbeiten mit korrekten Kopf- und Fußzeilen formatieren
• Formatierung der Abschlussarbeit: Kopf- und Fußzeilen zu Dissertationen und Masterarbeiten hinzufügen
• Lehrmaterialien: Verbessern Sie Ihre Bildungsdokumente mit Kopf- und Fußzeilen

Finance & Banking

Anwendungsfälle im Finanz- und Bankwesen

• Finanzberichte: Fügen Sie Finanzberichten und -abschlüssen Kopf- und Fußzeilen hinzu.
• Rechnungsformatierung: Rechnungen und Finanzdokumenten Kopf- und Fußzeilen hinzufügen
• Konformitätsdokumentation: Fügen Sie Konformitätsinformationen in Kopf- und Fußzeilen ein
• Prüfberichte: Fügen Sie Prüfberichten professionelle Kopf- und Fußzeilen hinzu.

Hilfe erhalten

Get Your API KeyAPI SamplesGetting Started