Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Substituir texto - Substituição de texto API

PDF4me Substituir texto Permite localizar e substituir texto em documentos do Word com opções de pesquisa avançadas. API O serviço processa arquivos do Word e realiza múltiplas operações de substituição com correspondência que diferencia maiúsculas de minúsculas e correspondência de palavras inteiras. API recebe conteúdo de documento Word através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para múltiplas operações de localizar e substituir em uma única solicitação, esta solução é ideal para automação de documentos, processamento de modelos e fluxos de trabalho de gerenciamento de conteúdo.

Artigos relacionados no blogue
Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.
Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.
Visite o blogue →

Autenticando seu API Solicitar​

Para acessar o PDF4me REST APIPara que uma solicitação seja aceita, é necessário incluir as credenciais de autenticação adequadas. A autenticação garante a segurança da comunicação e valida sua identidade como usuário autorizado do sistema. REST API.

Get your api Key

Principais características​

  • Substituição múltipla de textoExecutar várias operações de localizar e substituir em uma única ação.
  • Opções de pesquisa avançadaCorrespondência que diferencia maiúsculas de minúsculas e correspondência de palavras inteiras.
  • Processamento SequencialSubstituições múltiplas processadas na ordem especificada
  • Correspondência flexívelCorrespondências exatas, correspondências parciais ou correspondências de palavras inteiras
  • Estrutura simplesConjunto de operações de localizar e substituir fácil de usar

REST API Ponto final​

O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de substituição de texto são realizadas por meio de um único ponto de extremidade:

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

REST API Parâmetros​

Lista completa de parâmetros para a função Substituir Texto REST APIOs parâmetros estão organizados por categoria para melhor compreensão e implementação.

Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios. frases A matriz deve conter pelo menos uma frase de substituição.

Parâmetros obrigatórios​

ParâmetroTipoDescriçãoExemplo
documento*ObjectReferência do documento. Deve conter Nome (string): Nome do arquivo do Word com extensão .docx{ "Name": "document.docx" }
conteúdo do documento*Base64Conteúdo do documento Word codificado em Base64A substituição de texto foi realizada neste documento.UEsDBBQABgAIAAAA...
frases*ArrayMatriz de objetos de substituição. Deve conter pelo menos uma substituição. Cada substituição é processada sequencialmente na ordem especificada.Veja o exemplo abaixo.

Estrutura de objeto de substituição de texto (matriz de frases)​

Cada item no frases O array deve ser um objeto com a seguinte estrutura:

ParâmetroTipoDescriçãoExemplo
encontrarTexto*StringTexto a ser pesquisado no documento. Não pode ser nulo ou vazio. Diferencia maiúsculas de minúsculas ou não, dependendo da configuração `matchCase`. Todas as ocorrências deste texto serão substituídas."old text"
substituirTextoStringTexto que substituirá o texto encontrado. Pode ser uma string vazia para remover o texto encontrado. Padrão: string vazia (remove o texto encontrado)."new text"
matchMatchBooleanCorrespondência que diferencia maiúsculas de minúsculas. true = A pesquisa diferencia maiúsculas de minúsculas (é necessária a correspondência exata entre maiúsculas e minúsculas), false = A pesquisa não diferencia maiúsculas de minúsculas (padrão). Controla se "The" corresponde a "the" ou somente a "The".false
combinarPalavraInteiraBooleanCorrespondência de palavras inteiras. true = Encontrar apenas palavras completas (não correspondências parciais), false = Corresponde a texto parcial dentro de palavras (padrão). Impede que "o/a" corresponda a "lá" ou "outro/outra"false

Parâmetros opcionais​

ParâmetroTipoDescriçãoExemplo
nome_da_culturaStringCódigo de cultura para processamento de documentos (por exemplo, "en-US", "de-DE", "fr-FR")en-US

Processamento de Substituição de Texto​

  • Cada substituição é processada sequencialmente na ordem especificada.
  • É possível realizar várias substituições no mesmo documento.
  • Todas as ocorrências de "Localizar Texto" são substituídas (a menos que a correspondência de palavras inteiras esteja sendo usada).

Saída​

O PDF4me Substituir texto REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna o documento Word como um Base64string codificada em JSON formato, não como dados binários.

Processamento síncrono (padrão)

O API processa a solicitação e retorna:

Código de status: 200 OK

Tipo de conteúdo: application/json

Corpo da resposta:

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

Campos de resposta:

  • documento (string): O documento do Word com substituições de texto aplicadas, codificado como Base64 corda
  • nome_do_arquivo (string): O nome do arquivo Word de saída
  • sucesso (boolean): Indica se a solicitação foi bem-sucedida
  • mensagem de erro (string ou nulo): Detalhes do erro quando o sucesso for falso

Como usar:

  1. Extraia o document campo do JSON resposta (Base64)
  2. Decifre o Base64 string para obter os dados binários do documento Word
  3. Salve ou processe o arquivo do Word conforme necessário.

Exemplo (JavaScript):

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

Exemplo de solicitação​

Cabeçalho​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Observação:

  • Adquira o seu API chave do PDF4me Painel
  • O API a chave deve ser Base64 codificado e prefixado com "Básico" no Authorization cabeçalho
  • Exemplo: Se o seu API chave é abc123, codifique-o para Base64 e usar Authorization: Basic YWJjMTIz

Carga útil​

Exemplo básico (substituição simples):

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

Exemplo avançado (substituições múltiplas):

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

Exemplos de código​

O PDF4me Substituir texto REST API Fornece exemplos de código em várias linguagens de programação. Escolha a linguagem que melhor se adapta ao seu ambiente de desenvolvimento:

C# (CSharp) Amostra

Completo C# Implementação para substituir texto em documentos do Word:

Casos de uso e aplicações industriais​

Casos de uso de serviços jurídicos e profissionais

  • Processamento de ContratosSubstitua o texto de exemplo por informações específicas do cliente.
  • Automação de Documentos JurídicosAtualizar números de casos, nomes de clientes e datas.
  • Padronização de modelosPadronizar a terminologia e a formatação jurídica.
  • Comunicação com o clientePersonalizar documentos jurídicos para clientes específicos

Obtenha ajuda​

Get Your API KeyAPI SamplesGetting Started