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.
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
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| documento* | Object | Riferimento al documento. Deve contenere Nome string): Nome del file Word con estensione .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Il contenuto del documento Word codificato in Base64In questo documento viene eseguita una sostituzione del testo. | UEsDBBQABgAIAAAA... |
| frasi* | Array | Array 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:
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| trovaTesto* | String | Stringa 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 scorrevole | String | Testo 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 corrispondenza | Boolean | Corrispondenza 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 |
| matchWholeWord | Boolean | Corrispondenza 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
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| Nome della cultura | String | Codice 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.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
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:
- Estrarre il
documentcampo dal JSON risposta (Base64) - decodificare il Base64 stringa per ottenere i dati binari del documento Word
- 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
Elaborazione asincrona
Comportamento asincrono (202 Accepted con polling) è controllato dalla configurazione del server, non da un parametro del corpo della richiesta. Quando abilitato, il API potrebbe restituire uno stato 202 con un polling URL nel Location intestazione. Interroga l' URL con GET richieste fino a quando non ne ricevi 200 OK con la stessa struttura di risposta (documento, nomefile, successo, messaggiodierrore).
Risposte di errore
IL API resi standard HTTP Codici di errore con dettagli dell'errore:
- Parametri di richiesta non validi
- Campi obbligatori mancanti (
documentoconNome,docContent,frasi) - L'array delle frasi è nullo o vuoto
- Trova il testo nullo o vuoto in una sostituzione
- Non valido Base64 codifica in
docContent - Documento Word non valido o danneggiato
- Dimensione del carattere o parametri di formattazione non validi
- Non valido o mancante API chiave
- API chiave non corretta Base64 codificato in Authorization intestazione
- Mancante
Autorizzazione: Baseintestazione
- Errore di elaborazione lato server
- Errore nell'elaborazione del documento Word
- Errore di sostituzione del testo
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSON, mai dati Word binari direttamente.
Struttura della risposta:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
Intestazione Content-Type:
- Successo:
application/json - Il documento Word è incorporato come Base64 stringa all'interno della JSON risposta
Perché Base64?
- JSON- codifica sicura per dati binari
- Facile da trasmettere HTTP
- Compatibile con tutti i linguaggi di programmazione
- Può essere incorporato direttamente in JSON senza sfuggire ai problemi
Codifica Base64 al documento Word:
JavaScript/Node.js:
const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['docContent'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.docx", 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 utilizzareAuthorization: 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]",
"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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# CSharp) Campione
Completo C# Implementazione per la sostituzione del testo nei documenti Word:
Java Campione
Java implementazione con gestione completa degli errori ed elaborazione delle risposte:
JavaScript Campione
Node.js e compatibile con i browser JavaScript implementazione:
Google Script Campione
Google Apps Script implementazione per Google Workspace integrazione:
Casi d'uso e applicazioni industriali
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
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
Casi d'uso aziendali e per le imprese
- Generazione di proposte: Sostituire i modelli di proposta con informazioni specifiche del cliente
- Creazione di materiale di marketingAggiorna i modelli di marketing con i dettagli della campagna
- Comunicazione con il clientePersonalizzare i documenti di vendita per specifici potenziali clienti.
- Standardizzazione dei reportStandardizzare la terminologia e la formattazione delle vendite.
Casi d'uso in ambito educativo e di ricerca.
- Generazione di referti medici: Sostituire i modelli medici con informazioni specifiche del paziente
- Comunicazione con il pazientePersonalizzare i documenti medici per pazienti specifici.
- Documentazione di ricerca: Aggiornare i modelli di ricerca con i dati specifici dello studio
- Documentazione di conformità: Aggiornare i modelli di conformità medica agli standard attuali
Casi d'uso in ambito finanziario e bancario
- Generazione di report finanziari: Sostituire i dati del modello con i dati finanziari effettivi
- Elaborazione delle fattureAggiornare i modelli di fattura con le informazioni del cliente e di pagamento.
- Automazione dei documenti di bilancio: Sostituire i segnaposto del budget con le cifre effettive
- Generazione del report di auditAggiornare i modelli di audit con i risultati specifici dell'audit