优化文档 - 文档优化 API

PDF4me 优化文档 它能通过三种不同的压缩级别和全面的优化技术，帮助您优化 Word 文档的大小和性能。 API 该服务可处理 Word 文件并减小文件大小、压缩图像、清理内容、规范格式并删除个人信息。 API 通过以下方式接收 Word 文档内容 REST API 利用电话 Base64 采用编码技术实现安全传输。该解决方案支持低、中、高三种优化级别，文件大小可减少 0% 至 90%，是文档准备、存储优化和性能提升工作流程的理想之选。

相关博客文章

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

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

访问博客 →

验证您的身份 API 要求

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

Get your api Key

主要特点

• 最大优化：最大压缩率，最大限度减小文件大小
• 文件大小缩减通过最大程度的优化，文件大小可减少 80-90%。
• 图像压缩：在保持图像质量的前提下进行智能图像优化
• 内容清理删除未使用的宏、注释和隐藏内容
• 格式规范化清理冗余格式和未使用的样式
• 个人信息删除删除作者、管理员和公司信息
• 字体优化规范化字体并移除不必要的字体属性
• 兼容性增强优化文档以兼容 Word 2016

REST API 端点

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

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

REST API 参数

优化文档的完整参数列表 REST API参数按类别组织，以便更好地理解和实施。

重要的： 标有星号 (*) 的参数为必填项。优化级别决定了所应用优化技术的激进程度。

必需参数

范围	类型	描述	例子
文档*	Object	文件参考。必须包含 姓名 （字符串）：扩展名为 .docx 的 Word 文件名	{ "Name": "document.docx" }
文档内容*	Base64	Word文档内容编码 Base64原始文档未作修改，而是创建了新的优化版本。	UEsDBBQABgAIAAAA...

可选参数

范围	类型	描述	例子
优化级别	String	优化级别（例如：低、中、高）。 最大限度 - 最大压缩率（约 80-90%）。控制优化技术的激进程度。	"Max"
单词版本	String	为了兼容性，目标 Word 版本	null
文化名称	String	文档处理的区域性代码（例如“en-US”、“de-DE”、“fr-FR”）	en-US

优化方案

这 最大限度 优化方案可实现最大压缩：

• 文件大小缩减80-90%
• 图像质量针对尺寸进行了优化
• 格式化：彻底清理
• 评论已移除
• 修订已移除
• 个人信息已移除
• 宏已移除
• 未使用的样式已移除
• 隐藏内容已移除

输出

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

Success Response

同步处理（默认）

这 API 处理请求并返回：

状态码： 200 OK

内容类型： application/json

回复正文：

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

回复字段：

• 文档 （字符串）：经过优化的 Word 文档，文件大小已减小，编码为 Base64 细绳
• 文件名 （字符串）：输出的 Word 文件名
• 成功 （布尔值）：指示请求是否成功
• 错误信息 （字符串或 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 错误请求

• 无效的请求参数
• 缺少必填字段文档 和 姓名， 文档内容）
• 无效的 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.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);

请求示例

标题

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",
 "optimizationLevel": "Max"
}

高级示例（含可选字段）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "optimizationLevel": "Max",
 "wordVersion": null,
 "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