从 Word 中删除页面 - 页面管理 API
PDF4me 从 Word 文档中删除页面 此功能允许您使用灵活的页面选择选项从 Word 文档中删除特定页面或页面范围。 API 该服务处理 Word 文件,并使用基于范围的删除(从起始页到结束页)、特定页码删除(逗号分隔列表)和组合删除模式来删除页面。 API 通过以下方式接收 Word 文档内容 REST API 利用电话 Base64 采用编码技术确保传输安全。该解决方案支持对页面选择、文档优化和内容清理的全面控制,是文档完善、内容管理和文档准备工作流程的理想之选。
验证您的身份 API 要求
要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份。 REST API。
主要特点
- 灵活的页面选择按范围、特定编号或两者的组合删除页面
- 基于范围的删除删除从起始页到结束页的连续页面
- 特定页面删除使用逗号分隔的页码删除单个页面
- 文档优化清理文档,删除不需要的内容
- 格式保留保持文档的原始格式和结构
- 元数据保存保留文档属性和自定义元数据
- 验证自动页码验证和错误处理
- 文化支持:特定于区域设置的文档处理
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有页面删除操作均通过单个端点执行:
- 方法: POST
- 终点:
office/ApiV2Word/DeletePages
REST API 参数
从 Word 中删除页面的完整参数列表 REST API参数按类别组织,以便更好地理解和实施。
重要的: 标有星号 (*) 的参数为必填项。必须至少提供一个页面删除参数(startPage、endPage 或 pageNumbers)。
必需参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 文档* | Object | 文件参考。必须包含 姓名 (字符串):扩展名为 .docx 的 Word 文件名 | { "Name": "document.docx" } |
| 文档内容* | Base64 | Word文档内容编码 Base64 | UEsDBBQABgAIAAAA... |
可选参数(删除页面至少需要一项)
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 起始页 | Integer | 起始页码(从 1 开始索引)。要开始删除的页码。必须大于等于 1 且小于等于文档页数。如果只提供 startPage,则从该页删除到文档末尾。不能大于 endPage。 | 2 |
| 结束页 | Integer | 结束页码(从 1 开始索引)。停止删除的页码。必须大于等于起始页码且小于等于文档页数。范围包含起始页码和结束页码(删除起始页码和结束页码)。可与 pageNumbers 结合使用,以适应复杂的删除模式。 | 5 |
| 页码 | String | 以逗号分隔的要删除的特定页码列表。格式:“1,3,4”或“1-3,5,7-9”。可单独使用,也可与 startPage/endPage 组合使用。无效的页码将被忽略。例如:“2,4,6,8”将删除第 2、4、6 和 8 页。 | "2,4,6" |
| 文化名称 | String | 文档处理的区域性代码(例如,“en-US”、“de-DE”、“fr-FR”)。默认值:null(不进行区域性处理)。影响文档语言和格式。 | en-US |
页面删除模式
这 API 支持多种页面删除模式:
- 范围删除: 使用
startPage和endPage删除连续页面 - 特定页面删除: 使用
pageNumbers删除单个页面 - 合并删除同时使用范围参数和特定页面参数。
- 删除结束仅供使用
startPage从该页面删除文档末尾
笔记: 所有页码均从 1 开始(首页 = 1,而非 0)。页码会自动与文档页数进行核对。
输出
这 PDF4me 从 Word 文档中删除页面 REST API 根据处理模式的不同,会返回不同的响应。 API 返回 Word 文档。 Base64-编码字符串 JSON 格式不是二进制数据。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同步处理(默认)
这 API 处理请求并返回:
状态码: 200 OK
内容类型: application/json
回复正文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
回复字段:
- 文档 (字符串):已删除指定页面的 Word 文档,编码为 Base64 细绳
- 文件名 (字符串):输出的 Word 文件名
- 成功 (布尔值):指示请求是否成功
- 错误信息 (字符串或 null):成功失败时的错误详情
使用方法:
- 提取
document来自该领域的 JSON 回复 (Base64) - 解码 Base64 获取二进制 Word 文档数据的字符串
- 根据需要保存或处理 Word 文件
示例(JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
异步处理
异步行为(202) Accepted 轮询(或轮询)由服务器配置控制,而不是由请求体参数控制。启用后, API 可能会返回 202 状态码,并进行轮询 URL 在 Location 标题。轮询 URL 和 GET 直到收到 200 个请求为止 OK 响应格式相同(文档、文件名、成功、错误消息)。
错误响应
这 API 退货标准 HTTP 错误代码及错误详情:
- 无效的请求参数
- 缺少必填字段
文档和姓名,文档内容) - 至少需要一条页面删除条件(
起始页,结束页, 或者页码) - 无效的 Base64 编码
文档内容 - 无效或损坏的 Word 文档
起始页不能大于结束页- 无效的页码(超出文档范围)
- 无效或缺失 API 钥匙
- API 钥匙未正确 Base64 编码 Authorization 标题
- 丢失的
授权方式:基本标题
- 服务器端处理错误
- Word文档处理失败
- 页面删除失败
错误响应格式:
{
"error": "Error message describing what went wrong"
}
回复格式详情
重要的: 这 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.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("output.docx", wordBytes);
页面删除示例
了解不同的页面删除模式:
| 文档页 | 起始页 | 结束页 | 页码 | 结果 |
|---|---|---|---|---|
| 1、2、3、4、5 | 2 | 4 | - | 保留:1.5 |
| 1、2、3、4、5 | 3 | - | - | 保留:1,2 |
| 1、2、3、4、5 | - | - | 2,4 | 保留:1、3、5 |
| 1、2、3、4、5 | 2 | 3 | 5 | 保留:1.4 |
请求示例
标题
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": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"startPage": 2,
"endPage": 4
}
具体页面示例:
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"pageNumbers": "2,4,6,8"
}
高级示例(组合删除):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"startPage": 2,
"endPage": 5,
"pageNumbers": "7,9",
"cultureName": "en-US"
}
代码示例
这 PDF4me 从 Word 文档中删除页面 REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
行业应用案例及应用
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
法律及专业服务用例
- 合同清理从合同副本中移除签名页和附件。
- 法律文件准备:在分发给客户之前删除机密页面
- 法院文件优化删除不必要的页面以满足归档要求
- 客户文档版本:通过删除内部注释创建干净版本
商业及企业应用案例
- 提案优化从客户提案中移除内部成本页面
- 营销材料清理从现有资料中删除过时的内容页面
- 演示文稿准备从最终演示文稿中删除备用幻灯片和备注
- 客户交付物优化通过删除内部引用创建干净版本
教育与研究应用案例
- 医疗报告清理删除敏感的患者信息页面
- 研究文档优化从最终报告中删除初步数据
- 协议文件编制从已发布的协议中移除内部审查页面
- 合规文件:清理用于监管申报的文件
金融与银行业应用案例
- 财务报告清理从执行摘要中删除详细附录
- 预算文件优化从当前预算中删除历史数据页面
- 审计报告编制:在外部分发之前删除敏感的内部页面
- 监管文件清理优化文档以满足提交要求