Text durch Bild ersetzen – Bildersetzung API
PDF4me Text durch Bild ersetzen Ermöglicht das Ersetzen von bestimmtem Text durch Bilder in Word-Dokumenten mit erweiterten Seitenfilter- und Größenkontrolloptionen. API Der Dienst verarbeitet Word-Dateien und ersetzt Textplatzhalter durch Bilder mithilfe präziser Textübereinstimmung, anpassbarer Größe unter Beibehaltung des Seitenverhältnisses, seitenbezogener Ausrichtung und flexibler Filteroptionen. API empfängt Word-Dokumentinhalte und Bilddaten über REST API Anrufe, die genutzt werden Base64 Sichere Datenübertragung durch Kodierung. Dank Unterstützung mehrerer Bildformate und vollständiger Kontrolle über das Ersetzungsverhalten eignet sich diese Lösung ideal für Dokumentenautomatisierung, Vorlagenverarbeitung und Workflows zum dynamischen Einfügen von Inhalten.
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
- Text-zu-Bild-Ersetzung: Bestimmte Textzeichenfolgen in Dokumenten durch Bilder ersetzen
- Präziser Textabgleich: Groß-/Kleinschreibung beachtende Textsuche und -ersetzung
- Bildgrößensteuerung: Bildabmessungen mit Breiten- und Höhenparametern anpassen
- Beibehaltung des SeitenverhältnissesBildproportionen beim Skalieren beibehalten
- Seitenfilterung: Bestimmte Seiten oder Seitenbereiche für den Austausch auswählen
- Erweiterte Filterung: Erste Seite überspringen, ungerade/gerade Seiten auswählen oder genaue Seitenzahlen angeben
- Mehrere BildformateUnterstützung für PNG, JPG, JPEG, BMP, GIF Formate
- Flexible Positionierung: Fügen Sie Bilder als Word-Formen mit präziser Positionierung ein.
REST API Endpunkt
Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Text-zu-Bild-Ersetzungsvorgänge werden über einen einzigen Endpunkt durchgeführt:
- Verfahren: POST
- Endpunkt:
office/ApiV2Word/ReplaceTextWithImage
REST API Parameter
Vollständige Liste der Parameter für die Funktion „Text durch Bild ersetzen“. 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 der Bildgröße und Seitenfilterung.
Erforderliche Parameter
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| dokumentieren* | Object | Dokumentenbeschreibung. Muss enthalten Name (string): Ausgabedateiname (Word-Datei) mit der Erweiterung .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Word-Dokumentinhalt kodiert in Base64In diesem Dokument wird Text ersetzt. Es muss sich um ein gültiges Word-Dokument handeln (Formate: .docx, .doc). | base64EncodedDocumentContent |
| findText* | String | Suchtext im Dokument. Groß-/Kleinschreibung beachten. Alle Vorkommen werden durch das Bild ersetzt. Darf nicht leer sein. Beispiele: "[LOGO]", "SIGN_HERE" | "text to replace" |
| Bildinhalt* | Base64 | Inhalt der Ersatzbilddatei kodiert in Base64. Muss ein gültiges Bild sein (PNG, JPG, JPEG, BMP, GIF) | base64EncodedImageContent |
Optionale Parameter
| Parameter | Typ | Beschreibung | Beispiel |
|---|---|---|---|
| Breite | Zahl (doppelt) | Bildbreite | 200 |
| Höhe | Zahl (doppelt) | Bildhöhe | 100 |
| Seitenverhältnis beibehalten | Boolean | Bildproportionen beim Skalieren beibehalten. Standard: Ja | true |
| überspringenErsteSeite | Boolean | Ersetzung auf der ersten Seite überspringen. true = erste Seite überspringen, false = einschließen (Standardeinstellung). Nützlich für Deckblätter/Titelseiten | false |
| applyTo | String | Zielfernrohr für Ersatz | - |
| Seitenzahlen | String | Bestimmte Seitenzahlen oder Seitenbereiche (z. B. „1,2,3“ oder „1,3,5–7“). Leer = alle Seiten | "1,2,3" |
| Seitenzahlen ignorieren | String | Seitenzahlen, die von der Ersetzung ausgeschlossen werden sollen | - |
| Kulturname | String | Kulturcode (z. B. „en-US“, „fr-FR“, „de-DE“). Standard: null | en-US |
Seitenfilterung
Der API Unterstützt die Seitenfilterung über die folgenden Parameter:
- überspringenErsteSeiteSteuert, ob die erste Seite übersprungen werden soll.
- Seitenzahlen: Gibt an, welche Seiten verarbeitet werden sollen (leere Zeichenkette = alle Seiten)
- Seitenzahlen ignorieren: Auszuschließende Seitenzahlen
Unterstützte Bildformate
Text durch Bild ersetzen API Unterstützt verschiedene Bildformate für maximale Kompatibilität:
| Format | Verlängerung | Beschreibung |
|---|---|---|
| PNG | .png | Portable Network Graphics (PNG) – ideal für Logos und Grafiken mit Transparenz |
| JPEG | .jpg, .jpeg | Gemeinsame Expertengruppe für Fotografie – am besten geeignet für Fotografien und komplexe Bilder |
| BMP | .bmp | Bitmap – unkomprimiertes Format, größere Dateigrößen |
| GIF | .gif | Grafikaustauschformat – unterstützt Animation und Transparenz |
Ausgabe
Der PDF4me Text durch Bild ersetzen REST API gibt ein zurück JSON Antwort (ApiV2WordApiCallResBei Erfolg API gibt das Word-Dokument als Base64-kodierte Zeichenkette im document Feld, nicht als Binärdaten.
- Success Response
- Error Responses
- Response Format Details
Erfolgsantwort
Statuscode: 200 OK
Inhaltstyp: application/json
Antworttext:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
Antwortfelder:
- dokumentieren (string): Das Word-Dokument, in dem der Text durch Bilder ersetzt wurde, 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:
- Überprüfen
successFalls zutreffend, extrahieren Sie diedocumentFeld vom JSON Antwort - Entschlüsseln Sie die Base64 Zeichenkette zum Abrufen der binären Word-Dokumentdaten
- 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 wordBytes = atob(data.document);
// Save or process wordBytes
Fehlermeldungen
Der API Standard-Rückgabe HTTP Fehlercodes mit Fehlerdetails:
- Ungültige Anfrageparameter
- Fehlende Pflichtfelder (
dokumentieren,docContent,findText,Bildinhalt) - FindText ist null oder leer
- ImageContent ist null oder leer
- Ungültig Base64 Kodierung in
docContentoderBildinhalt - Ungültiges oder beschädigtes Word-Dokument
- Ungültige oder beschädigte Bilddatei
- Keine Seiten entsprechen den Filterkriterien
- Ungültig oder fehlend API Schlüssel
- API Schlüssel nicht richtig Base64 kodiert in Authorization Überschrift
- Fehlen
Autorisierung: BasisÜberschrift
- Serverseitiger Verarbeitungsfehler
- Fehler bei der Verarbeitung des Word-Dokuments
- Textersetzungsfehler
- Fehler beim Einfügen des Bildes
Fehlerantwortformat:
{
"error": "Error message describing what went wrong"
}
Details zum Antwortformat
Wichtig: Der API kehrt immer zurück JSON, niemals direkt binäre Word-Daten.
Antwortstruktur (ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": null
}
Content-Type-Header:
- Erfolg:
application/json - Das Word-Dokument 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 in Word-Dokument:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, 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 verwendenAuthorization: Basic YWJjMTIz
Nutzlast
Einfaches Beispiel (nur Pflichtfelder):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"cultureName": "en-US"
}
Erweitertes Beispiel (mit optionalen Feldern):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"width": 200,
"height": 100,
"maintainAspectRatio": true,
"skipFirstPage": true,
"pageNumbers": "1,2,3",
"ignorePageNumbers": null,
"cultureName": "en-US"
}
Codebeispiele
Der PDF4me Text durch Bild ersetzen 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) Probe
Vollständig C# Implementierung zum Ersetzen von Text durch Bilder in Word-Dokumenten:
Java Probe
Java Implementierung mit vollständiger Fehlerbehandlung und Antwortverarbeitung:
Python Probe
Python Implementierung mit der Requests-Bibliothek und JSON Handhabung:
Google Script Probe
Google Apps Script Implementierung für Google Workspace Integration:
Branchenspezifische Anwendungsfälle und Anwendungen
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Anwendungsfälle für Rechts- und Beratungsdienstleistungen
- Vertragsabwicklung: Platzhalter für Unterschriften durch autorisierte Unterschriften ersetzen
- Automatisierung juristischer Dokumente: Firmenlogos und Wasserzeichen in Rechtsdokumente einfügen
- Personalisierung von Kundendokumenten: Fügen Sie kundenspezifische Bilder zu Rechtsdokumenten hinzu
- Konformitätsdokumentation: Konformitätsstempel und Siegel in Dokumente einfügen
Anwendungsfälle für Unternehmen und Organisationen
- Angebotserstellung: Firmenlogos und Produktbilder in Angebote einfügen
- Erstellung von MarketingmaterialienPlatzhaltertext durch Marketingbilder ersetzen
- Automatisierung der Kundenpräsentation: Kundenspezifische Bilder in Präsentationen einfügen
- Erstellung von Verkaufsberichten: Füge Verkaufsdiagramme und Grafiken in Berichte ein
Anwendungsfälle in Bildung und Forschung
- Erstellung medizinischer Berichte: Medizinische Diagramme und Grafiken in Berichte einfügen
- Bearbeitung von Patientendokumenten: Logos von medizinischen Einrichtungen in Patientendokumente einfügen
- Forschungsdokumentation: Einfügen von Forschungsdiagrammen und Grafiken in Forschungsarbeiten
- Konformitätsdokumentation: Medizinische Konformitätsstempel in Dokumente einfügen
Anwendungsfälle im Finanz- und Bankwesen
- Erstellung von Finanzberichten: Diagramme und Grafiken in Finanzberichte einfügen
- Rechnungsverarbeitung: Ersetzen Sie die Logo-Platzhalter durch Firmenlogos
- Prüfdokumentation: Prüfstempel und Unterschriften in Prüfberichte einfügen
- Automatisierung von Budgetberichten: Budgetdiagramme in Budgetdokumente einfügen