Zum Hauptinhalt springen
PDF4me APIIntegrationenWissensdatenbankErweiterungenAPI-TesterBlog

Text ersetzen – Textaustausch API

PDF4me Text ersetzen ermöglicht das Suchen und Ersetzen von Text in Word-Dokumenten mithilfe erweiterter Suchoptionen. API Der Dienst verarbeitet Word-Dateien und führt mehrere Ersetzungsvorgänge mit Berücksichtigung der Groß-/Kleinschreibung und Ganzwortsuche durch. API empfängt Word-Dokumentinhalte über REST API Anrufe, die genutzt werden Base64 Verschlüsselung für sichere Übertragung. Dank der Unterstützung mehrerer Such- und Ersetzungsvorgänge in einer einzigen Anfrage eignet sich diese Lösung ideal für die Dokumentenautomatisierung, die Vorlagenverarbeitung und Workflows im Bereich Content-Management.

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 Textersetzungen: Führe mehrere Such- und Ersetzungsvorgänge in einem einzigen Vorgang aus
  • Erweiterte Suchoptionen: Groß-/Kleinschreibung beachten und Ganzwortvergleich
  • Sequenzielle VerarbeitungMehrere Ersetzungen werden in der angegebenen Reihenfolge verarbeitet
  • Flexibles Matching: Exakte Übereinstimmungen, Teilübereinstimmungen oder Übereinstimmungen ganzer Wörter
  • Einfache StrukturBenutzerfreundliches Array von Such- und Ersetzungsoperationen

REST API Endpunkt​

Der PDF4me REST API verwendet Standard HTTP Methoden zur Interaktion mit Ressourcen. Alle Textersetzungsoperationen werden über einen einzigen Endpunkt durchgeführt:

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

REST API Parameter​

Vollständige Liste der Parameter für die Funktion „Text ersetzen“ REST APIDie Parameter sind zur besseren Verständlichkeit und Implementierung nach Kategorien geordnet.

Wichtig: Mit einem Sternchen (*) gekennzeichnete Parameter sind Pflichtfelder. Phrasen Das Array muss mindestens einen Ersetzungsausdruck enthalten.

Erforderliche Parameter​

ParameterTypBeschreibungBeispiel
dokumentieren*ObjectDokumentenreferenz. Muss enthalten Name (string): Word-Dateiname mit der Erweiterung .docx{ "Name": "document.docx" }
docContent*Base64Word-Dokumentinhalt kodiert in Base64In diesem Dokument wird eine Textersetzung durchgeführt.UEsDBBQABgAIAAAA...
Phrasen*ArrayArray von Ersetzungsobjekten. Muss mindestens eine Ersetzung enthalten. Jede Ersetzung wird sequenziell in der angegebenen Reihenfolge verarbeitet.Siehe Beispiel unten

Textersetzungsobjektstruktur (Phrasen-Array)​

Jeder Gegenstand im Phrasen Das Array muss ein Objekt mit folgender Struktur sein:

ParameterTypBeschreibungBeispiel
findText*StringSuchtext im Dokument. Darf nicht leer sein. Groß-/Kleinschreibung wird je nach Einstellung „matchCase“ beachtet oder ignoriert. Alle Vorkommen dieses Textes werden ersetzt."old text"
ersetzenTextStringText, durch den der gefundene Text ersetzt werden soll. Kann eine leere Zeichenkette sein, um den gefundenen Text zu entfernen. Standardwert: leere Zeichenkette (entfernt den gefundenen Text)."new text"
matchCaseBooleanGroß-/Kleinschreibung beachten. true = Die Suche unterscheidet zwischen Groß- und Kleinschreibung (exakte Übereinstimmung erforderlich), false Die Suche unterscheidet nicht zwischen Groß- und Kleinschreibung (Standardeinstellung). Steuert, ob „The“ mit „the“ oder nur mit „The“ übereinstimmt.false
vollständiges WortBooleanGanzwortübereinstimmung. true = Nur vollständige Wörter finden (keine Teilübereinstimmungen), false = Teiltext innerhalb von Wörtern finden (Standard). Verhindert, dass „the“ auf „there“ oder „other“ trifft.false

Optionale Parameter​

ParameterTypBeschreibungBeispiel
KulturnameStringKulturcode für die Dokumentenverarbeitung (z. B. „en-US“, „de-DE“, „fr-FR“)en-US

Textersetzungsverarbeitung​

  • Jeder Austausch wird nacheinander in der angegebenen Reihenfolge verarbeitet.
  • Mehrere Ersetzungen können an demselben Dokument vorgenommen werden.
  • Alle Instanzen von „Text suchen“ werden ersetzt (außer bei Verwendung der Ganzwortsuche).

Ausgabe​

Der PDF4me Text ersetzen REST API Die Antwort hängt vom Verarbeitungsmodus ab. API gibt das Word-Dokument als Base64-kodierte Zeichenkette in JSON Format, nicht als Binärdaten.

Synchrone Verarbeitung (Standard)

Der API verarbeitet die Anfrage und gibt Folgendes zurück:

Statuscode: 200 OK

Inhaltstyp: application/json

Antworttext:

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

Antwortfelder:

  • dokumentieren (string): Das Word-Dokument mit angewendeten Textersetzungen, kodiert als Base64 Zeichenkette
  • Dateiname (string): Der Name der ausgegebenen Word-Datei
  • Erfolg (boolean): Gibt an, ob die Anfrage erfolgreich war.
  • Fehlermeldung (string oder null): Fehlerdetails, wenn Erfolg nicht gegeben ist

Anwendungshinweise:

  1. Extrahieren Sie die document Feld vom JSON Antwort (Base64)
  2. Entschlüsseln Sie die Base64 Zeichenkette zum Abrufen der binären Word-Dokumentdaten
  3. Speichern oder bearbeiten Sie die Word-Datei nach Bedarf.

Beispiel (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process 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 verwenden Authorization: Basic YWJjMTIz

Nutzlast​

Einfaches Beispiel (einfache Ersetzung):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "phrases": [
 {
 "findText": "old text",
 "replaceText": "new text",
 "matchCase": false,
 "matchWholeWord": false
 }
 ],
 "cultureName": "en-US"
}

Erweitertes Beispiel (Mehrere Ersetzungen):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "phrases": [
 {
 "findText": "[COMPANY_NAME]",
 "replaceText": "Acme Corporation",
 "matchCase": false,
 "matchWholeWord": false
 },
 {
 "findText": "[DATE]",
 "replaceText": "2024-01-15",
 "matchCase": false,
 "matchWholeWord": false
 },
 {
 "findText": "[CONTACT_EMAIL]",
 "replaceText": "[email protected]",
 "matchCase": false,
 "matchWholeWord": false
 }
 ],
 "cultureName": "en-US"
}

Codebeispiele​

Der PDF4me Text ersetzen 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 Ersetzen von Text in Word-Dokumenten:

Branchenspezifische Anwendungsfälle und Anwendungen​

Anwendungsfälle für Rechts- und Beratungsdienstleistungen

  • VertragsabwicklungPlatzhaltertext durch kundenspezifische Informationen ersetzen
  • Automatisierung juristischer Dokumente: Fallnummern, Mandantennamen und Daten aktualisieren
  • VorlagenstandardisierungStandardisierung der juristischen Terminologie und Formatierung
  • Kundenkommunikation: Personalisierung von Rechtsdokumenten für spezifische Mandanten

Hilfe erhalten​

Get Your API KeyAPI SamplesGetting Started