更新目录 - TOC 管理 API

PDF4me 更新目录 它使您能够在 Word 文档中更新或创建目录，并提供全面的格式选项和专业的样式功能。 API 服务处理 Word 文件并生成 TOC具有自动检测现有 TOC 字段、可自定义的标题级别、超链接支持、制表符分隔符控制、文本大小写选项和文化本地化。 API 通过以下方式接收 Word 文档内容 REST API 利用电话 Base64 加密用于安全传输。完全控制 TOC 该解决方案外观时尚、功能强大，是文档导航、专业格式化和自动化的理想之选。 TOC 生成工作流程。

相关博客文章

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

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

访问博客 →

验证您的身份 API 要求

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

Get your api Key

主要特点

• 自动的 TOC 检测查找并更新现有信息 TOC 字段或创建新字段
• 可自定义的标题级别控制要包含的标题级别（1-6）
• 超链接支持启用或禁用可点击链接 TOC
• 标签页领导控制显示或隐藏文本和页码之间的点
• 文本大小写选项使用大写字母或保留原大小写
• 文化本地化支持不同语言和地区
• 专业格式：专业应用的自动 TOC 造型
• 页码整合自动页码计算和更新

REST API 端点

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

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

REST API 参数

更新目录的完整参数列表 REST API参数按类别组织，以便更好地理解和实施。

重要的： 标有星号 (*) 的参数为必填项。高级参数可对参数进行更精细的控制。 TOC 格式和外观。

必需参数

范围	类型	描述	例子
文档*	Object	文件参考。必须包含 姓名 （string）：带有 .docx 扩展名的 Word 文件名	{ "Name": "document.docx" }
文档内容*	Base64	Word文档内容编码 Base64。 TOC 由本文档的标题生成。必须是有效的 Word 文档（.docx、.doc 格式）。	UEsDBBQABgAIAAAA...

可选参数

范围	类型	描述	例子
标题级别	String	要包含的标题级别 TOC范围格式：“1-3”（包含 1、2 和 3 级标题）。单级：“1”。多级范围：“1-2,4-6”。默认值：“1-3”。映射到 Word 内置的标题样式。扫描文档以查找现有标题。 TOC 字段。创建新字段 TOC 如果文档开头不存在，则在文档开头处。	"1-3"
使用超链接	Boolean	在目录中添加超链接。 true = TOC 条目均为可点击链接（默认）， false 纯文本	true
隐藏标签页引导线	Boolean	隐藏标签引导点。 true = 文本和页码之间不加点（默认）， false 文本和页码之间的点	true
使用大写字母	Boolean	使用大写字母 TOC 条目。 true = TOC 输入内容默认大写。 false = 原案例	true
文化名称	String	文档处理的区域性代码（例如，“en-US”、“de-DE”、“fr-FR”）。默认值：null。影响文档语言和格式。	en-US

TOC 生成行为

• 现存的 TOC 检测扫描文档以查找现有文档 TOC 字段（FieldType.FieldTOC）并更新它们
• 新的 TOC 创造如果没有 TOC 存在，创造新的 TOC 文档开头
• 标题级别映射：映射到 Word 内置的标题样式（一级标题、二级标题等）
• 现场更新为确保准确性，多次更新字段
• 页面布局按顺序调用 UpdateFields() 和 UpdatePageLayout()

输出

这 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.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": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

高级示例（包含所有选项）：

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-4",
 "useHyperlinks": true,
 "hideTabLeader": false,
 "useUppercase": false,
 "cultureName": "en-US"
}

学术论文范例：

{
 "document": { "Name": "research-paper.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "headingLevels": "1-3",
 "useHyperlinks": true,
 "hideTabLeader": true,
 "useUppercase": true
}

代码示例

这 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