合并文档 - 文档组装 API

PDF4me 合并文档 此功能可将多个 Word 文档合并为一个文档，并提供高级格式设置和合规性选项。 API 该服务可处理多个 Word 文件并将其合并，同时支持灵活的文档排序、可自定义的格式模式、合规级别设置、时区元数据和智能样式处理。 API 通过以下方式接收文档内容 REST API 利用电话 Base64 采用加密技术确保传输安全。该解决方案支持无限文档合并，并可完全控制合并行为，是文档组装、报表整合和内容管理工作流程的理想之选。

相关博客文章

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

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

访问博客 →

验证您的身份 API 要求

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

Get your api Key

主要特点

• 多文档支持将无限数量的文档合并成一个文档
• 简单数组结构易于使用的数组 Base64-编码文档内容
• 有序合并文档按其在数组中出现的顺序合并
• 基础文档概念第一份文件成为合并的基础
• 多格式支持合并 Word 文档、PDF 和其他支持的格式

REST API 端点

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

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

REST API 参数

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

重要的： 标有星号 (*) 的参数为必填项。 文件 数组必须至少包含一个文档。

必需参数

范围	类型	描述	例子
文件*	Array	要合并的文档对象数组。必须至少包含一个文档。每个对象必须有 文件名 （字符串）和 文档内容 （Base64 字符串）。文档按其在数组中出现的顺序合并。可选的文档字段： 排序位置 （整数）， 格式模式 （细绳）	[{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }]

可选参数

范围	类型	描述	例子
合并选项	Object	合并选项（格式、合规性等）。有关可用属性，请参阅插件模型。	{}

文件合并订单

文档将按照它们在数据库中出现的顺序合并。 文件 大批：

• 数组中的第一个文档成为 基础文档
• 所有后续文件均为 附加 按数组顺序到基础文档

输出

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

Success Response

同步处理（默认）

这 API 处理请求并返回：

状态码： 200 OK

内容类型： application/json

回复正文：

{
  "document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
  "fileName": "merged-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 文档内容编码
• 无效或损坏的文件

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

有效载荷

基本示例（两份文档）：

{
  "documents": [
    { "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
    { "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
  ]
}

高级示例（多文档合并选项）：

{
  "documents": [
    { "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
    { "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
    { "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
  ],
  "mergeOptions": {}
}

代码示例

这 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