Bildkopf und -fuß hinzufügen - Excel API
PDF4me Bild hinzufügen Kopf-Fußzeile ermöglicht es Ihnen, anpassbare Bildkopf- und -fußzeilen hinzuzufügen Excel Dokumente mit umfassender Positionierungs- und Formatierungskontrolle. API Serviceprozesse Excel Dateien und fügt Bildkopf- oder -fußzeilen mit Platzierungssteuerung (Kopf-/Fußzeile), horizontaler Ausrichtung (links, zentriert, rechts), Arbeitsblattausrichtung (bestimmte Blätter oder alle Blätter) und Seitenrändern in Zentimetern hinzu. API empfängt Excel Dokumentinhalte und Bilddaten durch REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Übertragung. Mit Unterstützung für PNG, JPG, JPEGDiese Lösung unterstützt unter anderem GIF-Bildformate und eignet sich ideal für Corporate Branding, professionelle Berichte und Workflows zur Dokumentenautomatisierung.
Authentifizierung Ihres API Anfrage
Fügen Sie Ihre API Geben Sie den Schlüssel in der Anfrage ein, um sich mit dem zu authentifizieren. PDF4me REST APIDie
Hauptmerkmale
- Platzierung von Kopf- oder FußzeileWählen Sie aus, ob Bilder im Kopf- oder Fußbereich des Dokuments platziert werden sollen.
- Positionssteuerung: Bilder im Kopf-/Fußbereich links, zentriert oder rechtsbündig ausrichten
- Arbeitsblatt-Zielgruppen: Bilder bestimmten Arbeitsblättern anhand ihres Namens oder Index oder allen Arbeitsblättern zuweisen
- Margenanpassung: Konfigurieren Sie die oberen, unteren, linken und rechten Seitenränder in Zentimetern
- Unterstützung für Bildformate: PNG, JPG, JPEGund GIF-Formate
REST API Endpunkt
Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Bildkopf-/fußzeilenoperationen für Excel werden über einen einzigen Endpunkt durchgeführt:
- Verfahren: POST
- Endpunkt:
office/ApiV2Excel/ExcelAddImageHeaderFooter
REST API Parameter
Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind erforderlich. Alle Anfragen verwenden dokumentieren, docContent, Bildinhalt (Wurzelebene) und addImageHeaderFooterToExcelActionAndere Optionen sind Eigenschaften des Aktionsobjekts.
Erforderliche Parameter (Stammebene)
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| dokumentieren* | Object | Dokumentenreferenz. Muss enthalten Name (Zeichenkette): Excel Dateiname mit der Erweiterung .xlsx oder .xls | { "Name": "data.xlsx" } |
| docContent* | String (Base64) | Excel Dokumentinhalt kodiert in Base64 | UEsDBBQABgAIAAAA... |
| Bildinhalt* | String (Base64) | Bilddateiinhalt kodiert in Base64Unterstützt PNG, JPG, JPEG, GIF-Formate | iVBORw0KGgoAAAANS... |
| addImageHeaderFooterToExcelAction* | Object | Aktionskonfiguration (Position, Arbeitsblattausrichtung, Ränder usw.) | Siehe untenstehendes Nutzlastbeispiel. |
Optionale Parameter (innerhalb von addImageHeaderFooterToExcelAction)
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| isHeader | Boolean | Auswahl der Praktikumsplätze. true = Bild zur Dokumentkopfzeile hinzufügen (Standard), false = Bild zur Dokumentfußzeile hinzufügen | true |
| Position | String | Horizontale Ausrichtung innerhalb der Kopf-/Fußzeile. Links, Center, oder RechtsStandardeinstellung: „Zentriert“. Groß-/Kleinschreibung wird nicht beachtet. | Center |
| Arbeitsblattnamen | Array (string[]) | Array mit den Namen der Arbeitsblätter, auf die das Bild angewendet werden soll. Wenn sowohl worksheetNames als auch worksheetIndexes leer sind, wird das Bild auf alle Arbeitsblätter angewendet. | ["Sheet1", "Report"] |
| Arbeitsblattindizes | Array (int[]) | Array von Arbeitsblattindizes (beginnend bei 1). Wenn sowohl worksheetNames als auch worksheetIndexes leer sind, gilt dies für alle Arbeitsblätter. | [1, 2] |
| obere Marge | Zahl (doppelt) | Oberer Seitenrand in Zentimetern. Standardwert: 1,9 | 1.9 |
| unterer Rand | Zahl (doppelt) | Unterer Seitenrand in Zentimetern. Standardwert: 1,9 | 1.9 |
| linker Rand | Zahl (doppelt) | Linker Seitenrand in Zentimetern. Standardwert: 1,9 | 1.9 |
| rechter Rand | Zahl (doppelt) | Rechter Seitenrand in Zentimetern. Standardwert: 1,9 | 1.9 |
| Kulturname | String | Kulturcode für die Dokumentenverarbeitung (z. B. „en-US“, „de-DE“, „fr-FR“) | en-US |
Notiz: Wenn beide Arbeitsblattnamen Und Arbeitsblattindizes Wenn die Felder leer oder null sind, wird das Bild auf alle Arbeitsblätter angewendet. Excel Datei.
Ausgabe
Der PDF4me Bild hinzufügen Kopf-Fußzeile REST API gibt zurück Excel Dokument als ein Base64-kodierte Zeichenkette in JSON Format, nicht als Binärdaten.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Synchrone Verarbeitung (Standard)
Der API verarbeitet die Anfrage und gibt Folgendes zurück:
Statuscode: 200 OK
Content-Type: application/json
Antworttext:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
Antwortfelder:
- dokumentieren (Zeichenkette): Die Excel Dokument mit angewendeter Bildkopf-/Bildfußzeile, kodiert als Base64 Zeichenkette
- Dateiname (Zeichenkette): Die Ausgabe Excel Dateiname
- Erfolg (Boolescher Wert): Gibt an, ob die Anfrage erfolgreich war.
- Fehlermeldung (Zeichenkette oder null): Fehlerdetails, wenn Erfolg nicht gegeben ist
Anwendungshinweise:
- Extrahieren Sie die
documentFeld vom JSON Antwort (Base64) - Entschlüsseln Sie die Base64 Zeichenkette, um die Binärdatei zu erhalten Excel Dokumentendaten
- Speichern oder verarbeiten Sie die Excel Datei nach Bedarf
Beispiel (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const excelBytes = atob(data.document); // Decode Base64
// Save or process excelBytes
Asynchrone Verarbeitung
Asynchrones Verhalten (202 Accepted (mit Polling) wird durch die Serverkonfiguration gesteuert, nicht durch einen Parameter im Anfragetext. Wenn aktiviert, API kann bei einer Abfrage den Statuscode 202 zurückgeben. URL im Location Überschrift. Fragen Sie die URL mit GET Stellen Sie so lange Anfragen, bis Sie 200 erhalten. OK mit der gleichen Antwortstruktur (Dokument, Dateiname, Erfolgsmeldung, Fehlermeldung).
Fehlermeldungen
Der API Standard-Rückgabe HTTP Fehlercodes mit Fehlerdetails:
- Ungültige Anfrageparameter
- Fehlende Pflichtfelder (
dokumentierenmitName,docContent,Bildinhalt,addImageHeaderFooterToExcelAction) - Ungültig Base64 Kodierung in
docContentoderBildinhalt - Ungültig oder beschädigt Excel dokumentieren
- Ungültige oder beschädigte Bilddatei
- Ungültige Arbeitsblattauswahl (Namen oder Indizes existieren nicht oder liegen außerhalb des gültigen Bereichs)
- Ungültig oder fehlend API Schlüssel
- API Schlüssel nicht richtig Base64 kodiert in Authorization Überschrift
- Fehlen
Autorisierung: BasisÜberschrift
- Serverseitiger Verarbeitungsfehler
- Excel Fehler bei der Dokumentenverarbeitung
- Fehler beim Hinzufügen von Bildkopf-/Fußzeilen
Fehlerantwortformat:
{
"error": "Error message describing what went wrong"
}
Details zum Antwortformat
Wichtig: Der API kehrt immer zurück JSONniemals binär Excel Daten direkt.
Antwortstruktur:
{
"document": "string", // Base64-encoded Excel document content
"fileName": "string", // Output Excel filename
"success": true,
"errorMessage": "string or null"
}
Dekodierung Base64 Zu Excel Dokumentieren:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
excel_bytes = base64.b64decode(response['document'])
with open('output.xlsx', 'wb') as f:
f.write(excel_bytes)
C#:
byte[] excelBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.xlsx", excelBytes);
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):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {}
}
Erweitertes Beispiel (mit allen optionalen Feldern):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {
"isHeader": true,
"position": "Center",
"worksheetNames": ["Sheet1", "Report"],
"worksheetIndexes": [1, 2],
"topMargin": 1.9,
"bottomMargin": 1.9,
"leftMargin": 1.9,
"rightMargin": 1.9,
"cultureName": "en-US"
}
}
Codebeispiele
Der PDF4me Füge Bildkopf-Fußzeile hinzu Excel 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
C# (CSharp) Beispiel
Vollständig C# Implementierung zum Hinzufügen von Bildkopf-/fußzeilen zu Excel Dokumente:
Java Probe
Java Implementierung mit vollständiger Fehlerbehandlung und Antwortverarbeitung:
Python Probe
Python Implementierung mit der Requests-Bibliothek und JSON Handhabung:
Branchenspezifische Anwendungsfälle und Anwendungen
- Finance & Accounting
- Sales & Marketing
- Human Resources
- Operations & Manufacturing
- Healthcare & Medical
- Legal & Professional Services
Anwendungsfälle im Finanz- und Rechnungswesen
- Finanzberichte: Fügen Sie den Quartalsberichten die Überschriften mit dem Firmenlogo hinzu.
- Haushaltsberichte: Abteilungslogos in Budgettabellen einfügen
- Prüfdokumente: Wasserzeichen mit dem Logo der Wirtschaftsprüfungsgesellschaft in den Fußzeilen einfügen
- Spesenabrechnungen: Firmenlogo-Kopfzeilen für Spesenabrechnungen hinzufügen
Anwendungsfälle im Bereich Vertrieb & Marketing
- Verkaufsberichte: Firmenlogos in wöchentliche Verkaufsberichte einfügen
- Preislisten: Logo-Header zu Kundenpreisdokumenten hinzufügen
- Marketingberichte: Kampagnenlogos auf Analyseberichte anwenden
- Kundenpräsentationen: Kundenlogos für die gemeinsame Markenführung zu den Liefergegenständen hinzufügen
Anwendungsfälle im Personalwesen
- Lohnabrechnungen: Firmenlogos auf Gehaltsabrechnungen einfügen
- Mitarbeiterdaten: Logo der Personalabteilung zu Personalvorlagen hinzufügen
- Anmeldung zu Sozialleistungen: Logos der Leistungsanbieter auf die Anmeldeformulare auftragen
- Leistungsbeurteilungen: Fügen Sie den Bewertungsvorlagen Ihr Corporate Branding hinzu
Anwendungsfälle im Bereich Betrieb und Fertigung
- Inventarberichte: Logos der Lagerstandorte auf den Inventarlisten einfügen
- Produktionsberichte: Logos der Produktionsstätten zu Fertigungsberichten hinzufügen
- Qualitätsberichte: Logos für Qualitätszertifizierungen in Kopfzeilen einfügen
- Lieferkettenberichte: Fügen Sie Lieferantenlogos zu Beschaffungsdokumenten hinzu
Anwendungsfälle im Gesundheitswesen und in der Medizin
- Patientenberichte: Fügen Sie den Patientendaten Logos von Krankenhäusern oder Kliniken hinzu.
- Laborergebnisse: Laborlogo auf den Testergebnisbögen einfügen
- Versicherungsansprüche: Logos der Versicherungsanbieter auf Schadensdokumente auftragen
- Krankenakten: Fügen Sie das Branding der Einrichtung zu den Gesundheitsinformationsblättern hinzu.
Anwendungsfälle für Rechts- und Beratungsdienstleistungen
- Kundenberichte: Logo der Anwaltskanzlei in die Kundendokumente einfügen
- Falldokumente: Logos der Rechtsgebiete zu den Akten hinzufügen
- Vertragsvorlagen: Firmenbranding auf Vertragsarbeitsblätter anwenden
- RechnungsbelegeFirmenlogo auf Rechtskostenabrechnungen einfügen