查找和替换文本 - 内容编辑器 API
PDF4me 查找和替换文本 使您能够查找和替换特定的文本模式 PDF 文件。这 API 服务流程 PDF 文件和搜索功能用于查找指定页面上需要替换的文本。 API 接收 PDF 通过内容和替换参数 REST API 利用电话 Base64 采用加密技术实现安全传输。该解决方案支持灵活的页面定位和文本模式匹配,是文档更新和内容管理工作流程的理想之选。
验证您的身份 API 要求
要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份。 REST API。
主要特点
- 文本模式匹配查找并替换特定文本模式 PDF 文件
- 灵活的页面定位:使用自定义页面序列处理特定页面或整个文档
- 页面顺序支持:指定单个页面、页面范围或混合页面选择
- Base64 编码:使用安全文件内容传输 Base64 编码
- 简单的 API 一体化RESTful API 专为自动化而设计 PDF 文本编辑工作流程
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有文本查找和替换操作均通过单个端点执行:
- 方法: POST
- 终点:
/api/v2/FindAndReplace
REST API 参数
查找和替换文本功能的完整参数列表 REST API参数按类别组织,以便更好地理解和实施。
重要的: 标有星号 (*) 的参数为必填项,必须提供。 API 正常运作。
必需参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| docContent* | Base64 | 输入的内容 PDF 文件编码为 Base64 | JVBERi... |
| docName* | String | 来源 PDF 文件名带有 .pdf 扩展名 | output.pdf |
| oldText* | String | 要搜索和替换的文本 | This is some |
| newText* | String | 要替换的文本 | Here is few |
| pageSequence* | String | 页面选项:“1”表示第1页,“1,3,5”表示特定页码,“2-5”表示页码范围,“1,3,7-10”表示混合页码,“1-”表示从第1页到最后一页 | 1 |
可选参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| async | Boolean | 启用异步处理。 true, 这 API 返回 202 状态并提供轮询 URL 在位置标题中 | true |
输出
这 PDF4me 查找和替换文本 REST API 根据处理模式的不同,会返回不同的响应。 API 返回 PDF 作为 二进制数据 用于同步处理或提供轮询 URL 用于异步处理。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同步处理(默认)
什么时候 async 未设置或已设置为 false, 这 API 立即处理请求:
状态码: 200 OK
内容类型: application/pdf 或者 application/octet-stream
回复正文:
这 API 返回 PDF 直接以二进制数据格式(而非)文件形式保存 JSON)。
使用方法:
- 响应体包含二进制数据 PDF 数据
- 将响应内容直接保存为 PDF 文件
- 不 Base64 二进制响应需要解码
示例(JavaScript):
const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly
异步处理
什么时候 async: true 已设定, API 异步处理请求:
状态码: 202 Accepted
响应头:
Location: https://api.pdf4me.com/api/v2/FindAndReplace/poll/12345-abcde-67890
投票过程:
- 提取
Location来自 202 响应的标头 - 民意调查 URL 使用 GET 请求
- 继续轮询,直到收到 200 OK 地位
- 最终响应包含二进制数据 PDF 数据
轮询示例:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const pdfBlob = await pollResponse.blob();
// Process binary PDF
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
错误响应
| 状态码 | 描述 | 示例回答 |
|---|---|---|
| 400 Bad Request | 请求参数无效或缺少必填字段 | {"error": "Missing required parameter: oldText"} |
| 401 Unauthorized | 无效或缺失 API 钥匙 | {"error": "Unauthorized"} |
| 500 Internal Server Error | 处理过程中出现服务器错误 | {"error": "Internal server error"} |
了解反应
- 同步(200)返回二进制数据 PDF 数据直接
- 异步(202)返回用于轮询的 Location 标头,最终响应为二进制数据。 PDF
- 不 JSON 包装纸: 这 API 返回 PDF 作为二进制文件,未封装 JSON 和 Base64 编码
请求示例
标题
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
笔记: 这 API 关键必须是 Base64 已编码。获取您的 API 钥匙 PDF4me 仪表板
有效载荷
{
"docContent": "JVBERi...",
"docName": "output.pdf",
"oldText": "input_old_text",
"newText": "output_new_text",
"pageSequence": "1"
}
代码示例
这 PDF4me 查找和替换文本 REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
文本替换功能
文本模式处理
- 精确匹配区分大小写的文本模式匹配,用于精确识别
- 模式识别支持特定词语、短语和文本模式
- 自定义图案:针对特定文本替换需求创建灵活的模式
- 专业成果:可靠的文本替换,精准的模式匹配
- 高级处理支持复杂的文本结构和格式
页面处理
- 页面定位替换特定页面或整个文档中的文本
- 页面顺序支持自定义页面范围和单个页面选择
- 柔性加工:精确控制地处理任意页面组合
- 批量处理高效地在单个页面中处理多个页面 API 呼叫
- 专业布局在所有目标页面中实现一致的文本替换
高级功能
- 文本分析:综合文本模式分析与识别
- 内容管理高级内容编辑和文本替换选项
- 专业编辑高质量文本替换,清晰可见
- 灵活模式支持任何文本模式和替换要求
行业应用案例及应用
- Business & Enterprise
- Legal & Professional Services
- Finance & Banking
- Government & Compliance
商业及企业应用案例
- 文件更新自动更新多个位置的文本内容 PDF 文件
- 内容管理用最新数据替换过时信息 PDF 文件
- 模板处理:在文档模板中,使用实际内容更新占位符文本
- 品牌管理更新公司名称、徽标和品牌元素 PDFs
法律及专业服务用例
- 法律文件编辑替换法律文件中的特定术语和条款 PDF 文件
- 合同更新更新所有法律文件中的合同条款和细则
- 合规性更新替换文档中的监管信息和合规数据
- 法律文件标准化统一各文件中的法律术语
金融与银行业应用案例
- 报告生成更新生成的指标、日期和数据点。 PDF 报告
- 财务文件更新更新财务信息 PDF 文件
- 合规性更新替换财务文件中的监管信息
- 财务报告标准化统一各报告中的财务术语
政府及合规应用案例
- 合规性更新替换文档中的监管信息和合规数据
- 监管文件更新政府文件中的监管信息
- 文件标准化:统一文档集中的术语和格式
- 公共记录更新公共记录和政府文件中的信息