Substituir texto por imagem - Substituição de imagem API
PDF4me Substituir texto por imagem Permite substituir texto específico por imagens em documentos do Word, com opções avançadas de filtragem de página e controle de tamanho. API O serviço processa arquivos do Word e substitui espaços reservados de texto por imagens, utilizando correspondência de texto precisa, dimensionamento personalizável com preservação da proporção, direcionamento específico da página e opções de filtragem flexíveis. API recebe conteúdo de documentos do Word e dados de imagem através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para múltiplos formatos de imagem e controle total sobre o comportamento de substituição, esta solução é ideal para automação de documentos, processamento de modelos e fluxos de trabalho de inserção de conteúdo dinâmico.
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.
Principais características
- Substituição de texto por imagemSubstituir trechos de texto específicos por imagens em todo o documento.
- Correspondência de texto precisa: Busca e substituição de texto que diferencia maiúsculas de minúsculas
- Controle de tamanho da imagemPersonalize as dimensões da imagem com os parâmetros de largura e altura.
- Preservação da proporção da telaManter as proporções da imagem durante o redimensionamento.
- Filtragem de páginasSelecione páginas ou intervalos de páginas específicos para substituição.
- Filtragem AvançadaIgnore a primeira página, selecione páginas pares/ímpares ou especifique os números de página exatos.
- Vários formatos de imagemSuporte para PNG, JPG, JPEG, BMP, GIF formatos
- Posicionamento flexívelInsira imagens como formas do Word com posicionamento preciso.
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 por imagem são realizadas por meio de um único ponto de extremidade:
- Método: POST
- Ponto final:
office/ApiV2Word/ReplaceTextWithImage
REST API Parâmetros
Lista completa de parâmetros para a função "Substituir texto por imagem". 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. Os parâmetros avançados oferecem controle preciso sobre o tamanho da imagem e a filtragem da página.
Parâmetros obrigatórios
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| documento* | Object | Descrição do documento. Deve incluir Nome (string): nome do arquivo Word de saída com extensão .docx | { "Name": "document.docx" } |
| conteúdo do documento* | Base64 | Conteúdo do documento Word codificado em Base64Este documento foi submetido a substituição de texto. Deve ser um documento Word válido (formatos .docx ou .doc). | base64EncodedDocumentContent |
| encontrarTexto* | String | Texto a ser pesquisado no documento. Diferencia maiúsculas de minúsculas. Todas as ocorrências serão substituídas pela imagem. Não pode ser nulo ou vazio. Exemplos: "[LOGO]", "ASSINE_AQUI" | "text to replace" |
| conteúdo da imagem* | Base64 | Conteúdo do arquivo de imagem de substituição codificado em Base64Deve ser uma imagem válida (PNG, JPG, JPEG, BMP, GIF) | base64EncodedImageContent |
Parâmetros opcionais
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| largura | Número (duplo) | Largura da imagem | 200 |
| altura | Número (duplo) | Altura da imagem | 100 |
| manterProporção | Boolean | Manter as proporções da imagem durante o redimensionamento. Padrão: verdadeiro | true |
| pularPrimeiraPágina | Boolean | Ignorar substituição na primeira página. true = pular a primeira página, false = incluir (padrão). Útil para páginas de capa/título. | false |
| aplicar | String | Âmbito alvo para substituição | - |
| Números de página | String | Números de página ou intervalos específicos (por exemplo, "1,2,3" ou "1,3,5-7"). Vazio = todas as páginas. | "1,2,3" |
| ignorarNúmerosDePágina | String | Números de página a excluir da substituição | - |
| nome_da_cultura | String | Código de cultura (por exemplo, "en-US", "fr-FR", "de-DE"). Padrão: nulo | en-US |
Filtragem de páginas
O API Suporta filtragem de páginas através dos seguintes parâmetros:
- pularPrimeiraPágina: Controla se a primeira página deve ser ignorada.
- Números de página: Especifica quais páginas processar (string vazia = todas as páginas)
- ignorarNúmerosDePáginaNúmeros de página a excluir
Formatos de imagem suportados
Substituir texto por imagem API Suporta diversos formatos de imagem para máxima compatibilidade:
| Formatar | Extensão | Descrição |
|---|---|---|
| PNG | .png | Gráficos de Rede Portáteis (PNG) - ideais para logotipos e gráficos com transparência. |
| JPEG | .jpg, .jpeg | Grupo Conjunto de Especialistas em Fotografia - a melhor opção para fotografias e imagens complexas. |
| BMP | .bmp | Bitmap - formato não comprimido, tamanhos de arquivo maiores |
| GIF | .gif | Formato de Intercâmbio de Gráficos (GIF) - suporta animação e transparência. |
Saída
O PDF4me Substituir texto por imagem REST API retorna um JSON resposta (ApiV2WordApiCallRes). Com o sucesso, API retorna o documento Word como um Base64string codificada no document campo, não como dados binários.
- Success Response
- Error Responses
- Response Format Details
Resposta bem-sucedida
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 o texto substituído por imagens, codificado como Base64
- nome_do_arquivo (string): O nome do arquivo Word de saída
- sucesso (boolean): Se a operação foi bem-sucedida
- mensagem de erro (string): Mensagem de erro se sucesso for falso; caso contrário, nulo
Como usar:
- Verificar
success; se verdadeiro, extraia odocumentcampo do JSON resposta - Decifre o Base64 string para obter os dados binários do documento Word
- Salve ou processe o arquivo do Word usando
fileName
Exemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const wordBytes = atob(data.document);
// Save or process wordBytes
Respostas de erro
O API retorna padrão HTTP Códigos de erro com detalhes do erro:
- Parâmetros de solicitação inválidos
- Campos obrigatórios ausentes (
documento,conteúdo do documento,encontrarTexto,conteúdo da imagem) - FindText é nulo ou vazio
- ImageContent é nulo ou vazio
- Inválido Base64 codificação em
conteúdo do documentoouconteúdo da imagem - Documento do Word inválido ou corrompido
- Arquivo de imagem inválido ou corrompido
- Nenhuma página corresponde aos critérios de filtragem.
- Inválido ou ausente API chave
- API chave não está corretamente Base64 codificado em Authorization cabeçalho
- Ausente
Autorização: Básicacabeçalho
- Erro de processamento no servidor
- falha no processamento do documento Word
- Falha na substituição de texto
- Falha na inserção da imagem
Formato da resposta de erro:
{
"error": "Error message describing what went wrong"
}
Detalhes do formato da resposta
Importante: O API sempre retorna JSON, nunca dados binários do Word diretamente.
Estrutura de Resposta (ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": null
}
Cabeçalho Content-Type:
- Sucesso:
application/json - O documento do Word está incorporado como um Base64 string dentro do JSON resposta
Por que Base64?
- JSON-Codificação segura para dados binários
- Fácil de transmitir HTTP
- Compatível com todas as linguagens de programação.
- Pode ser incorporado diretamente em JSON sem escapar dos problemas
Decodificando Base64 Para documento do Word:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, 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 usarAuthorization: Basic YWJjMTIz
Carga útil
Exemplo básico (somente campos obrigatórios):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"cultureName": "en-US"
}
Exemplo avançado (com campos opcionais):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"findText": "text to replace",
"imageContent": "base64EncodedImageContent",
"width": 200,
"height": 100,
"maintainAspectRatio": true,
"skipFirstPage": true,
"pageNumbers": "1,2,3",
"ignorePageNumbers": null,
"cultureName": "en-US"
}
Exemplos de código
O PDF4me Substituir texto por imagem 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Amostra
Completo C# Implementação para substituir texto por imagens em documentos do Word:
Java Amostra
Java Implementação com tratamento completo de erros e processamento de respostas:
JavaScript Amostra
Node.js e compatível com navegadores JavaScript Implementação:
Google Script Amostra
Google Apps Script implementação para Google Workspace integração:
Casos de uso e aplicações industriais
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casos de uso de serviços jurídicos e profissionais
- Processamento de ContratosSubstitua os espaços reservados para assinatura por assinaturas autorizadas.
- Automação de Documentos JurídicosInserir logotipos e marcas d'água da empresa em documentos legais.
- Personalização de documentos do clienteAdicionar imagens específicas do cliente a documentos jurídicos
- Documentação de ConformidadeInsira carimbos e selos de conformidade nos documentos.
Casos de uso para empresas e negócios
- Geração de propostasInserir logotipos da empresa e imagens de produtos nas propostas
- Criação de Material de MarketingSubstitua o texto de exemplo por imagens de marketing.
- Automação de Apresentação ao ClienteInserir imagens específicas do cliente nas apresentações
- Geração de Relatórios de VendasInserir gráficos e tabelas de vendas em relatórios
Casos de uso em educação e pesquisa
- Geração de Relatórios MédicosInserir gráficos e diagramas médicos em relatórios.
- Processamento de Documentos do PacienteInserir logotipos de instalações médicas em documentos de pacientes.
- Documentação de pesquisaInserir tabelas e gráficos de pesquisa em trabalhos acadêmicos.
- Documentação de ConformidadeInsira os carimbos de conformidade médica nos documentos.
Casos de uso em finanças e bancos
- Geração de Relatórios FinanceirosInserir gráficos e tabelas em relatórios financeiros.
- Processamento de faturasSubstitua os espaços reservados para logotipos pelos logotipos da empresa.
- Documentação de auditoriaInserir carimbos e assinaturas de auditoria nos relatórios de auditoria.
- Automação de Relatórios OrçamentáriosInserir gráficos orçamentários em documentos orçamentários