替换文本 - 文本替换 API

PDF4me 替换文本 此功能可让您使用高级搜索选项在 Word 文档中查找和替换文本。 API 该服务处理 Word 文件，并执行多项替换操作，包括区分大小写匹配和全词匹配。 API 通过以下方式接收 Word 文档内容 REST API 利用电话 Base64 采用编码实现安全传输。该解决方案支持在单个请求中执行多个查找和替换操作，是文档自动化、模板处理和内容管理工作流程的理想之选。

相关博客文章

目前尚无关于此功能的博客文章——敬请期待。

在此期间，您可以浏览 PDF4me 博客，查看适用于各平台的教程和工作流程。

访问博客 →

验证您的身份 API 要求

要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全，并验证您作为授权用户的身份。 REST API。

Get your api Key

主要特点

• 多重文本替换在一次操作中执行多个查找和替换操作
• 高级搜索选项区分大小写匹配和整词匹配
• 顺序处理：按指定顺序处理多个替换件
• 灵活匹配完全匹配、部分匹配或全词匹配
• 简单结构易于使用的查找和替换操作数组

REST API 端点

这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有文本替换操作均通过单个端点执行：

• 方法： POST
• 终点： office/ApiV2Word/ReplaceText

REST API 参数

替换文本功能的完整参数列表 REST API参数按类别组织，以便更好地理解和实施。

重要的： 标有星号 (*) 的参数为必填项。 短语 数组必须至少包含一个替换短语。

必需参数

范围	类型	描述	例子
文档*	Object	文件参考。必须包含 姓名 （string）：带有 .docx 扩展名的 Word 文件名	{ "Name": "document.docx" }
文档内容*	Base64	Word文档内容编码 Base64本文档已执行文本替换操作。	UEsDBBQABgAIAAAA...
短语*	Array	替换对象数组。必须至少包含一个替换对象。每个替换对象将按指定顺序依次处理。	请看下面的示例。

文本替换对象结构（短语数组）

每件物品 短语 数组必须是一个具有以下结构的对象：

范围	类型	描述	例子
查找文本*	String	要在文档中搜索的文本字符串。不能为空或为 null。区分大小写或不区分大小写取决于 matchCase 设置。所有匹配的文本都将被替换。	"old text"
替换文本	String	要替换找到的文本的文本。可以为空字符串以删除找到的文本。默认值：空字符串（删除找到的文本）。	"new text"
匹配大小写	Boolean	区分大小写匹配。 true 搜索区分大小写（必须完全匹配大小写）， false 搜索不区分大小写（默认）。控制“The”是否匹配“the”或仅匹配“The”。	false
matchWholeWord	Boolean	整词匹配。 true = 只匹配完整的单词（不匹配部分单词）， false = 匹配单词中的部分文本（默认）。防止“the”匹配“there”或“other”。	false

可选参数

范围	类型	描述	例子
文化名称	String	文档处理的区域性代码（例如“en-US”、“de-DE”、“fr-FR”）	en-US

文本替换处理

• 每个替换件都按指定顺序依次处理。
• 可以对同一文档执行多次替换操作。
• 所有“查找文本”实例都会被替换（除非使用全词匹配）。

输出

这 PDF4me 替换文本 REST API 根据处理模式的不同，会返回不同的响应。 API 返回 Word 文档。 Base64-编码字符串 JSON 格式不是二进制数据。

Success Response

同步处理（默认）

这 API 处理请求并返回：

状态码： 200 OK

内容类型： application/json

回复正文：

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

回复字段：

• 文档 （string）：应用文本替换后的 Word 文档，编码为 Base64 细绳
• 文件名 （string输出的 Word 文件名
• 成功 （boolean）：指示请求是否成功
• 错误信息 （string （或 null）：成功为假时的错误详情

使用方法：

1. 提取 document 来自该领域的 JSON 回复 （Base64）
2. 解码 Base64 获取二进制 Word 文档数据的字符串
3. 根据需要保存或处理 Word 文件

示例（JavaScript）：

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

Asynchronous Processing

异步处理

异步行为（202） Accepted 轮询机制由服务器配置控制，而不是由请求体参数控制。启用后， API 可能会返回 202 状态码，并进行轮询 URL 在 Location 标题。轮询 URL 和 GET 直到收到 200 个请求为止 OK 响应格式相同（文档、文件名、成功、错误消息）。

Error Responses

错误响应

这 API 退货标准 HTTP 错误代码及错误详情：

400 Bad Request

• 无效的请求参数
• 缺少必填字段文档 和 姓名， 文档内容， 短语）
• 短语数组为空或为空
• 查找文本为空或空字符串
• 无效的 Base64 编码 文档内容
• 无效或损坏的 Word 文档
• 字体大小或格式参数无效

401 Unauthorized

• 无效或缺失 API 钥匙
• API 钥匙未正确 Base64 编码 Authorization 标题
• 丢失的 授权方式：基本 标题

500 Internal Server Error

• 服务器端处理错误
• Word文档处理失败
• 文本替换失败

错误响应格式：

{
"error": "Error message describing what went wrong"
}

Response Format Details

回复格式详情

重要的： 这 API 总是返回 JSON绝不会直接处理二进制 Word 数据。

响应结构：

{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}

内容类型标头：

• 成功： application/json
• Word 文档以嵌入方式呈现。 Base64 字符串内部 JSON 回复

为什么 Base64？

• JSON-二进制数据的安全编码
• 易于传输 HTTP
• 与所有编程语言兼容
• 可以直接嵌入 JSON 不回避问题

解码 Base64 转换为 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);

请求示例

标题

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

笔记：

• 获得你的 API 钥匙来自 PDF4me 仪表板
• 这 API 关键必须是 Base64 编码后以“Basic”为前缀 Authorization 标题
• 例如：如果你的 API 关键是 abc123将其编码为 Base64 并使用 Authorization: Basic YWJjMTIz

有效载荷

基本示例（单替换）：

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

进阶示例（多重替换）：

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

代码示例

这 PDF4me 替换文本 REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言：

C#

C# （CSharp） 样本

完全的 C# Word文档中文本替换的实现方法：

View C# Sample

Java

Java 样本

Java 实现了完整的错误处理和响应处理功能：

View Java Sample

JavaScript

JavaScript 样本

Node.js 并且与浏览器兼容 JavaScript 执行：

View JavaScript Sample

Python

Python 样本

Python 使用 requests 库实现 JSON 处理：

View Python Sample

Salesforce

Salesforce 样本

Salesforce Apex 实施 CRM 一体化：

View Salesforce Sample

n8n

n8n 样本

n8n 自动化工作流程实施：

View n8n Sample

Google Script

Google Script 样本

Google Apps Script 实施 Google Workspace 一体化：

View Google Script Sample

AWS Lambda

AWS Lambda 样本

无服务器 AWS Lambda 函数实现：

View AWS Lambda Sample

行业应用案例及应用

Legal & Professional Services

法律及专业服务用例

• 合同处理：将占位符文本替换为客户特定信息
• 法律文件自动化更新案件编号、客户姓名和日期
• 模板标准化规范法律术语和格式
• 客户沟通为特定客户定制法律文件

Business & Enterprise

商业及企业应用案例

• 提案生成用客户特定信息替换提案模板
• 营销材料制作更新营销模板，添加营销活动详情
• 客户沟通为特定潜在客户定制销售文件
• 报告标准化规范销售术语和格式

Education & Research

教育与研究应用案例

• 医疗报告生成用患者特定信息替换医疗模板
• 患者沟通为特定患者定制医疗文件
• 研究文档：使用特定研究数据更新研究模板
• 合规文件：根据最新标准更新医疗合规模板

Finance & Banking

金融与银行业应用案例

• 生成财务报告用实际财务指标替换模板数据
• 发票处理更新发票模板，添加客户和付款信息
• 预算文档自动化将预算占位符替换为实际数字
• 审计报告生成更新审计模板，使其包含具体的审计结果

获取帮助

Get Your API KeyAPI SamplesGetting Started