Füge die Seitenzahl hinzu PDF - Seitennummerierung API
PDF4me Füge die Seitenzahl hinzu PDF ermöglicht es Ihnen, anpassbare Seitenzahlen hinzuzufügen PDF Dokumente mit Kontrolle über Position, Format und Stil. API Serviceprozesse PDF Dateien und fügt Seitenzahlen mithilfe von Formatplatzhaltern hinzu, wobei # stellt die aktuelle Seitenzahl dar und {1} stellt die Gesamtzahl der Seiten dar. API empfängt PDF Inhalte durch REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Übertragung. Diese Lösung eignet sich ideal für die Dokumentenorganisation, juristische Dokumente, wissenschaftliche Arbeiten und Unternehmenszwecke. PDF Arbeitsabläufe.
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
Hauptmerkmale
- Flexible Formatierung: Wählen Sie aus mehreren Seitenzahlenformaten mit
#für die aktuelle Seite und{1}für die Gesamtzahl der Seiten (z. B. "Anzahl der Seiten") 1", "Seite #") - Präzise Positionierung: Horizontale und vertikale Ausrichtung mit pixelgenauer Präzision steuern
- Individuelles Styling: Schriftgröße, Fettdruck, Kursivschrift und andere Textformatierungsoptionen anpassen
- Margenkontrolle: Legen Sie präzise Abstände in Millimetern für eine optimale Platzierung fest.
- Erste Seite überspringenOption zum Ausblenden der Seitenzahlen auf der ersten Seite
- Professionelle Ergebnisse: Einheitliche, professionelle Seitennummerierung in allen Dokumenten erstellen
REST API Endpunkt
Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Operationen zum Hinzufügen von Seitenzahlen werden über einen einzigen Endpunkt ausgeführt:
- Verfahren: POST
- Endpunkt:
/api/v2/AddPageNumber
REST API Parameter
Vollständige Liste der Parameter für die Funktion „Seitenzahl hinzufügen“ 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* | Zeichenkette | Ausgabe PDF Dateiname mit der Erweiterung .pdf | output.pdf |
| docContent* | Base64 | PDF Dateiinhalt kodiert in Base64 | JVBERi... |
| Seitenzahlenformat* | Zeichenkette | Seitenzahlenformat. Verwenden Sie # für die aktuelle Seitenzahl, {1} für die Gesamtzahl der Seiten. Beispiele: "Anzahl der 1", "Seite #", "# / 1" | # of {1} |
| alignX* | Zeichenkette | Horizontale Ausrichtung: links, Center, oder Rechts | right |
| alignY* | Zeichenkette | Vertikale Ausrichtung: Spitze, Mitte, oder unten | bottom |
Optionale Parameter
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| marginXinMM | Ganze Zahl | Horizontaler Abstand vom Rand in Millimetern (0-100) | 2 |
| Marge in mm | Ganze Zahl | Vertikaler Abstand vom Rand in Millimetern (0-100) | 2 |
| Schriftgröße | Ganze Zahl | Schriftgröße für Seitenzahlen (8-72) | 12 |
| Eisball | Boolescher Wert | Seitenzahlen fett (wahr) oder normal (falsch) darstellen | true |
| isItalic | Boolescher Wert | Seitenzahlen kursiv (wahr) oder normal (falsch) darstellen | false |
| überspringenErsteSeite | Boolescher Wert | Seitennummerierung auf der ersten Seite überspringen (wahr) oder einbeziehen (falsch) | false |
| asynchron | Boolescher Wert | 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 |
Platzhalter für Seitenzahlenformat
Der pageNumberFormat Der Parameter verwendet die folgenden Platzhalter:
#- Ersetzt durch die aktuelle Seitenzahl (1, 2, 3 usw.).{1}- Ersetzt durch die Gesamtseitenzahl
Formatbeispiele:
"# of {1}"→ Zeigt "1 von 10", "2 von 10", "3 von 10" usw. an."Page #"→ Zeigt "Seite 1", "Seite 2", "Seite 3" usw. an."# / {1}"→ Zeigt "1 / 10", "2 / 10", "3 / 10" usw. an."- # -"→ Zeigt "- 1 -", "- 2 -", "- 3 -", usw. an."[#/{1}]"→ Zeigt "[1/10]", "[2/10]", "[3/10]", usw. an."(#)"→ Zeigt "(1)", "(2)", "(3)", usw. an."#"→ Zeigt nur die Seitenzahl an: "1", "2", "3", usw.
Ausgabe
Der PDF4me Füge Seitenzahlen hinzu 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
- Asynchronous Processing
- Error Responses
- Response Format Details
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 hinzugefügten Seitenzahlen, kodiert als Base64 Zeichenkette
Anwendungshinweise:
- Extrahieren Sie die
docContentFeld vom JSON Antwort - Entschlüsseln Sie die Base64 Zeichenkette, um die Binärdatei zu erhalten PDF Daten
- 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
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/AddPageNumber/poll/12345-abcde-67890
Abstimmungsverfahren:
- Extrahieren Sie die
LocationHeader der 202-Antwort - Befragen Sie die URL Verwendung GET Anfragen
- Nehmen Sie so lange an der Umfrage teil, bis Sie eine Antwort erhalten. 200 OK Status
- Die endgültige Antwort enthält dasselbe JSON Format mit
docNameUnddocContent(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
}
Fehlermeldungen
Der API Standard-Rückgabe HTTP Fehlercodes mit Fehlerdetails:
- Ungültige Anfrageparameter
- Fehlende Pflichtfelder (
docContent,docName,Seitenzahlenformat,alignX,alignY) - Ungültig Base64 Kodierung in
docContent - Ungültige Ausrichtungswerte (müssen für alignX "left", "center", "right" und für alignY "top", "middle", "bottom" sein).
- Ungültige Schriftgröße (muss zwischen 8 und 72 liegen)
- Ungültige Margenwerte (müssen ganze Zahlen zwischen 0 und 100 sein)
- Ungültig oder fehlend API Schlüssel
- API Schlüssel nicht richtig Base64 kodiert in Authorization Überschrift
- Fehlen
Autorisierung: BasisÜberschrift
- Serverseitiger Verarbeitungsfehler
- PDF Verarbeitungsfehler
- Fehler beim Hinzufügen der Seitenzahl
Fehlerantwortformat:
{
"error": "Error message describing what went wrong"
}
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 verwendenAuthorization: Basic YWJjMTIz
Nutzlast
Einfaches Beispiel (nur Pflichtfelder):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"pageNumberFormat": "# of {1}",
"alignX": "right",
"alignY": "bottom"
}
Erweitertes Beispiel (mit allen optionalen Feldern):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"pageNumberFormat": "# of {1}",
"alignX": "right",
"alignY": "bottom",
"marginXinMM": 2,
"marginYinMM": 2,
"fontSize": 12,
"isBold": true,
"isItalic": false,
"skipFirstPage": false,
"async": true
}
Codebeispiele
Der PDF4me Füge die Seitenzahl hinzu PDF REST API Es werden Codebeispiele in verschiedenen Programmiersprachen bereitgestellt. Wählen Sie die Sprache, die am besten zu Ihrer Entwicklungsumgebung passt:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Beispiel
Vollständig C# Implementierung zum Hinzufügen von Seitenzahlen PDF:
Java Probe
Java Implementierung mit vollständiger Fehlerbehandlung und Antwortverarbeitung:
Python Probe
Python Implementierung mit der Requests-Bibliothek und JSON Handhabung:
Seitenzahlenfunktionen
Formatierungsoptionen
- Mehrere FormateUnterstützung für verschiedene Nummerierungsstile und -muster
- Flexible PositionierungPräzise Steuerung der Seitenzahlenplatzierung
- Individuelles Styling: Volle Kontrolle über Schriftbild und Formatierung
- Steuerung der ersten SeiteOption zum Ausschließen der Deckblätter von der Nummerierung
Dokumentenoptimierung
- Professionelles Layout: Einheitliche, professionelle Seitennummerierung für alle Dokumente erstellen
- Druckoptimierung: Seitenzahlen für unterschiedliche Druckanforderungen optimieren
- Digitaler Vertrieb: Formatierung auf verschiedenen Anzeigegeräten beibehalten
- Markenkonsistenz: Einheitliche Seitennummerierungsstandards organisationsweit anwenden
Erweiterte Funktionen
- Stapelverarbeitung: Mehrere Dokumente mit einheitlicher Seitennummerierung verarbeiten
- Qualitätssicherung: Sicherstellen, dass die Seitenzahlen korrekt und vollständig sind PDF Kompatibilität
- LayouterhaltungDie Dokumentstruktur beim Hinzufügen von Seitenzahlen beibehalten.
- Benutzerdefinierte MargenPräzise Kontrolle über die Positionierung der Seitenzahlen
Branchenspezifische Anwendungsfälle und Anwendungen
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Government & Compliance
Anwendungsfälle für Rechts- und Beratungsdienstleistungen
- RechtsdokumentationSeiten in Verträgen, Vereinbarungen und Schriftsätzen nummerieren
- Gerichtsdokumente: Fügen Sie Seitenzahlen zu Gerichtsdokumenten und juristischen Schriftsätzen hinzu.
- Konformitätsdokumentation: Seitenzahlen in Compliance- und Regulierungsdokumenten
- Kundendokumentation: Kundendokumente mit Seitennummerierung organisieren
Anwendungsfälle in Bildung und Forschung
- Wissenschaftliche Arbeiten: Forschungsarbeiten und Abschlussarbeiten mit korrekter Seitennummerierung formatieren
- Forschungsdokumente: Fügen Sie Seitenzahlen zu Forschungsarbeiten und Publikationen hinzu.
- Formatierung der AbschlussarbeitSeitenzahlen in Dissertationen und Masterarbeiten
- LehrmaterialienOrganisieren Sie Bildungsdokumente mit Seitenzahlen.
Anwendungsfälle für Unternehmen und Organisationen
- GeschäftsberichteErstellen Sie professionelle Berichte mit einheitlicher Seitennummerierung
- Dokumentenorganisation: Fügen Sie Seitenzahlen zu Berichten, Handbüchern und technischen Dokumenten hinzu.
- Technische HandbücherOrganisieren Sie die technische Dokumentation mit klaren Seitenverweisen.
- Unternehmensdokumentation: Seitenzahlen in Unternehmensdokumenten und Handbüchern
Anwendungsfälle im Bereich Regierung und Compliance
- ArchivdokumenteDokumente für die Langzeitarchivierung mit Seitenzahlen vorbereiten
- Regierungsberichte: Fügen Sie Regierungsberichten und -dokumenten Seitenzahlen hinzu.
- RegulierungsdokumentationSeitenzahlen in regulatorischen und Compliance-Dokumenten
- Öffentliche AufzeichnungenOrganisieren Sie öffentliche Aufzeichnungen mit Seitennummerierung.