Saltar al contenido principal
PDF4me APIIntegracionesBase de conocimientosExtensionesProbador de APIBlog

Reemplazar texto - Sustitución de texto API

PDF4me Reemplazar texto Te permite buscar y reemplazar texto en documentos de Word con opciones de búsqueda avanzadas. API El servicio procesa archivos de Word y realiza múltiples operaciones de reemplazo con coincidencia sensible a mayúsculas y minúsculas y coincidencia de palabra completa. API recibe el contenido del documento de Word a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Gracias a su compatibilidad con múltiples operaciones de búsqueda y reemplazo en una sola solicitud, esta solución es ideal para la automatización de documentos, el procesamiento de plantillas y los flujos de trabajo de gestión de contenido.

Entradas de blog relacionadas
Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.
Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.
Visita el blog →

Autenticando su API Pedido​

Para acceder al PDF4me REST APICada solicitud debe incluir las credenciales de autenticación adecuadas. La autenticación garantiza una comunicación segura y valida su identidad como usuario autorizado del sistema. REST API.

Get your api Key

Características principales​

  • Sustituciones de texto múltiples: Realizar múltiples operaciones de búsqueda y reemplazo en una sola acción.
  • Opciones de búsqueda avanzadaCoincidencia sensible a mayúsculas y minúsculas y coincidencia de palabras completas
  • Tratamiento secuencial: Múltiples reemplazos procesados en el orden especificado
  • Emparejamiento flexibleCoincidencias exactas, coincidencias parciales o coincidencias de palabras completas
  • Estructura simpleConjunto de operaciones de búsqueda y reemplazo fáciles de usar

REST API Punto final​

El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de reemplazo de texto se realizan a través de un único punto final:

  • Método: POST
  • Punto final: office/ApiV2Word/ReplaceText

REST API Parámetros​

Lista completa de parámetros para la función Reemplazar texto REST APILos parámetros están organizados por categoría para una mejor comprensión e implementación.

Importante: Los parámetros marcados con un asterisco (*) son obligatorios. frases La matriz debe contener al menos una frase de reemplazo.

Parámetros requeridos​

ParámetroTipoDescripciónEjemplo
documento*ObjectReferencia del documento. Debe contener Nombre (string): Nombre del archivo de Word con extensión .docx{ "Name": "document.docx" }
docContent*Base64Contenido del documento de Word codificado en Base64Se realiza una sustitución de texto en este documento.UEsDBBQABgAIAAAA...
frases*ArrayMatriz de objetos de reemplazo. Debe contener al menos un reemplazo. Cada reemplazo se procesa secuencialmente en el orden especificado.Vea el ejemplo a continuación.

Estructura del objeto de reemplazo de texto (matriz de frases)​

Cada artículo en el frases El array debe ser un objeto con la siguiente estructura:

ParámetroTipoDescripciónEjemplo
encontrar texto*StringCadena de texto que se buscará en el documento. No puede ser nula ni estar vacía. Distingue entre mayúsculas y minúsculas según la configuración de matchCase. Se reemplazarán todas las instancias de este texto."old text"
reemplazarTextoStringTexto con el que reemplazar el texto encontrado. Puede ser una cadena vacía para eliminar el texto encontrado. Valor predeterminado: cadena vacía (elimina el texto encontrado)."new text"
coincidencia de mayúsculas y minúsculasBooleanCoincidencia sensible a mayúsculas y minúsculas. true = La búsqueda distingue entre mayúsculas y minúsculas (se requiere coincidencia exacta de mayúsculas y minúsculas). false = La búsqueda no distingue entre mayúsculas y minúsculas (predeterminado). Controla si "The" coincide con "the" o solo con "The".false
matchWholeWordBooleanCoincidencia de palabras completas. true = Coincidencia solo de palabras completas (no coincidencias parciales), false = Coincidencia de texto parcial dentro de palabras (predeterminado). Impide que "the" coincida con "there" u "other".false

Parámetros opcionales​

ParámetroTipoDescripciónEjemplo
Nombre de la culturaStringCódigo cultural para el procesamiento de documentos (por ejemplo, "en-US", "de-DE", "fr-FR")en-US

Procesamiento de reemplazo de texto​

  • Cada reemplazo se procesa secuencialmente en el orden especificado.
  • Se pueden realizar múltiples sustituciones en el mismo documento.
  • Se reemplazan todas las instancias de Buscar texto (a menos que se utilice la coincidencia de palabra completa).

Producción​

El PDF4me Reemplazar texto REST API devuelve diferentes respuestas según el modo de procesamiento. API devuelve el documento de Word como un Base64cadena codificada en JSON formato, no como datos binarios.

Procesamiento síncrono (predeterminado)

El API procesa la solicitud y devuelve:

Código de estado: 200 OK

Tipo de contenido: application/json

Cuerpo de la respuesta:

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

Campos de respuesta:

  • documento (string): El documento de Word con reemplazos de texto aplicados, codificado como Base64 cadena
  • Nombre del archivo (string): El nombre del archivo de Word de salida
  • éxito (boolean): Indica si la solicitud se realizó correctamente
  • mensaje de error (string o nulo): Detalles del error cuando el éxito es falso

Cómo usarlo:

  1. Extraer el document campo del JSON respuesta (Base64)
  2. Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
  3. Guarde o procese el archivo de Word según sea necesario.

Ejemplo (JavaScript):

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

Ejemplo de solicitud​

Encabezamiento​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Nota:

  • Consigue tu API clave del PDF4me Panel
  • El API La clave debe ser Base64 codificado y prefijado con "Basic" en el Authorization encabezado
  • Ejemplo: Si su API La clave es abc123, codificarlo a Base64 y usar Authorization: Basic YWJjMTIz

Carga útil​

Ejemplo básico (sustitución simple):

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

Ejemplo avanzado (múltiples sustituciones):

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

Ejemplos de código​

El PDF4me Reemplazar texto REST API Proporciona ejemplos de código en varios lenguajes de programación. Elija el lenguaje que mejor se adapte a su entorno de desarrollo:

C# (CSharp) Muestra

Completo C# Implementación para reemplazar texto en documentos de Word:

Casos de uso y aplicaciones en la industria​

Casos de uso de servicios legales y profesionales

  • Procesamiento de contratos: Reemplazar el texto de marcador de posición con información específica del cliente
  • Automatización de documentos legalesActualizar números de caso, nombres de clientes y fechas.
  • Estandarización de plantillasEstandarizar la terminología y el formato legales.
  • Comunicación con el clientePersonalizar documentos legales para clientes específicos.

Obtén ayuda​

Get Your API KeyAPI SamplesGetting Started