Passa al contenuto principale

Sostituisci testo - Sostituzione del testo API

PDF4me Sostituisci il testo consente di trovare e sostituire il testo nei documenti Word con opzioni di ricerca avanzate. Questo API Il servizio elabora i file Word ed esegue molteplici operazioni di sostituzione con corrispondenza sensibile alle maiuscole e minuscole e corrispondenza di parole intere. API riceve il contenuto del documento Word tramite REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Grazie al supporto per più operazioni di ricerca e sostituzione in un'unica richiesta, questa soluzione è ideale per l'automazione dei documenti, l'elaborazione di modelli e i flussi di lavoro di gestione dei contenuti.

Articoli correlati del blog
Non ci sono ancora post sul blog dedicati a questa funzionalità — in arrivo a breve.
Nel frattempo, dai un'occhiata al blog di PDF4me per trovare tutorial e procedure operative su tutte le piattaforme.
Visita il blog

Autenticazione del tuo API Richiesta

Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.

Caratteristiche principali

  • Sostituzioni di testo multiple: Esegui più operazioni di ricerca e sostituzione in un'unica azione
  • Opzioni di ricerca avanzata: Corrispondenza sensibile alle maiuscole e minuscole e corrispondenza di parole intere
  • Elaborazione sequenziale: Sostituzioni multiple elaborate nell'ordine specificato
  • Abbinamento flessibileCorrispondenze esatte, corrispondenze parziali o corrispondenze di parole intere
  • Struttura semplice: Ampia gamma di operazioni di ricerca e sostituzione facili da usare

REST API Punto finale

IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di sostituzione del testo vengono eseguite tramite un unico endpoint:

  • Metodo: POST
  • Punto finale: office/ApiV2Word/ReplaceText

REST API Parametri

Elenco completo dei parametri per la funzione Sostituisci testo REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.

Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori. frasi L'array deve contenere almeno una frase di sostituzione.

Parametri richiesti

ParametroTipoDescrizioneEsempio
documento*ObjectRiferimento al documento. Deve contenere Nome string): Nome del file Word con estensione .docx{ "Name": "document.docx" }
docContent*Base64Il contenuto del documento Word codificato in Base64In questo documento viene eseguita una sostituzione del testo.UEsDBBQABgAIAAAA...
frasi*ArrayArray di oggetti di sostituzione. Deve contenere almeno una sostituzione. Ogni sostituzione viene elaborata in sequenza nell'ordine specificato.Vedi l'esempio qui sotto

Struttura dell'oggetto per la sostituzione del testo (array di frasi)

Ogni elemento nel frasi L'array deve essere un oggetto con la seguente struttura:

ParametroTipoDescrizioneEsempio
trovaTesto*StringStringa di testo da cercare nel documento. Non può essere nulla o vuota. Difficoltà a distinguere tra maiuscole e minuscole a seconda dell'impostazione matchCase. Tutte le occorrenze di questo testo verranno sostituite"old text"
testo scorrevoleStringTesto con cui sostituire il testo trovato. Può essere una stringa vuota per rimuovere il testo trovato. Predefinito: stringa vuota (rimuove il testo trovato)"new text"
Caso di corrispondenzaBooleanCorrispondenza sensibile alle maiuscole/minuscole. true = La ricerca è sensibile alle maiuscole/minuscole (è richiesta la corrispondenza esatta tra maiuscole e minuscole), false = La ricerca non distingue tra maiuscole e minuscole (impostazione predefinita). Controlla se "The" corrisponde a "the" o solo a "The"false
matchWholeWordBooleanCorrispondenza di parole intere. true = Corrispondenza solo con parole complete (non corrispondenze parziali), false = Corrispondenza parziale del testo all'interno delle parole (impostazione predefinita). Impedisce che "the" corrisponda a "there" o "other"false

Parametri opzionali

ParametroTipoDescrizioneEsempio
Nome della culturaStringCodice culturale per l'elaborazione dei documenti (ad esempio, "en-US", "de-DE", "fr-FR")en-US

Elaborazione di sostituzione del testo

  • Ogni sostituzione viene elaborata in sequenza nell'ordine specificato
  • È possibile effettuare più sostituzioni sullo stesso documento
  • Tutte le occorrenze di Trova testo vengono sostituite (a meno che non si utilizzi la corrispondenza di parole intere).

Produzione

IL PDF4me Sostituisci il testo REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il documento Word come un Base64-stringa codificata in JSON formato, non come dati binari.

Elaborazione sincrona (impostazione predefinita)

IL API elabora la richiesta e restituisce:

Codice di stato: 200 OK

Tipo di contenuto: application/json

Corpo della risposta:

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

Campi di risposta:

  • documento string): Il documento Word con le sostituzioni di testo applicate, codificato come Base64 corda
  • Nome file string): Il nome del file Word di output
  • successo boolean): Indica se la richiesta è andata a buon fine
  • messaggio di errore string o null): Dettagli dell'errore quando il successo è falso

Come si usa:

  1. Estrarre il document campo dal JSON risposta (Base64)
  2. decodificare il Base64 stringa per ottenere i dati binari del documento Word
  3. Salva o elabora il file Word secondo necessità.

Esempio (JavaScript):

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

Esempio di richiesta

Intestazione

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
  • IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
  • Esempio: se il tuo API la chiave è abc123, codificalo in Base64 e utilizzare Authorization: Basic YWJjMTIz

Carico utile

Esempio base (sostituzione singola):

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

Esempio avanzato (sostituzioni multiple):

{
"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"
}

Esempi di codice

IL PDF4me Sostituisci il testo REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:

C# CSharp) Campione

Completo C# Implementazione per la sostituzione del testo nei documenti Word:

Casi d'uso e applicazioni industriali

Casi d'uso per servizi legali e professionali

  • Elaborazione contrattuale: Sostituire il testo segnaposto con le informazioni specifiche del cliente
  • Automazione dei documenti legaliAggiornare i numeri di pratica, i nomi dei clienti e le date.
  • Standardizzazione dei modelliStandardizzare la terminologia e la formattazione legale.
  • Comunicazione con il cliente: Personalizzare documenti legali per clienti specifici

Richiedi assistenza