跳到主要内容
PDF4me API集成知识库扩展API 测试员博客

更新页眉和页脚 - 页眉管理 API

PDF4me 更新页眉和页脚 使您能够全面地在 Word 文档中添加或修改页眉和页脚。 HTML 内容支持和专业造型选项。这 API 该服务处理 Word 文件，并为不同的页面布局（包括首页、奇数/偶数页和所有页面）应用页眉和页脚，并自动应用专业的默认样式。 HTML 内容处理和灵活的页面特定格式设置。 API 通过以下方式接收 Word 文档内容 REST API 利用电话 Base64 用于安全传输的编码。支持页码字段（PAGE， NUMPAGES， SECTION， SECTIONPAGES）， HTML 该解决方案具备格式化和自动专业样式功能，是文档品牌化、页码标注和专业文档演示工作流程的理想选择。

相关博客文章
目前尚无关于此功能的博客文章——敬请期待。
在此期间，您可以浏览 PDF4me 博客，查看适用于各平台的教程和工作流程。
访问博客 →

验证您的身份 API 要求​

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

Get your api Key

主要特点​

  • 多种页面类型支持所有页面、首页、偶数页/奇数页
  • HTML 内容支持： 富有的 HTML 内容需具备专业造型
  • 自动造型：纯文本内容的专业默认样式
  • 页码字段支持 PAGE， NUMPAGES， SECTION， SECTIONPAGES
  • 灵活布局：不同页面类型使用不同的页眉/页脚
  • 文化支持：特定于区域设置的文档处理
  • 格式保留保持原始文档结构
  • 专业形象自动应用专业造型

REST API 端点​

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

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

REST API 参数​

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

重要的： 标有星号 (*) 的参数为必填项。高级参数可对页面特定的页眉和页脚进行更精细的控制。

必需参数​

范围类型描述例子
文档*Object文档描述符。必须包含 姓名 （string输出带有 .docx 扩展名的 Word 文件名{ "Name": "document.docx" }
文档内容*Base64Word文档内容编码 Base64本文档已添加页眉和页脚。必须是有效的 Word 文档（.docx、.doc 格式）。base64EncodedDocumentContent

可选参数（页眉/页脚） HTML）​

范围类型描述例子
标题内容String简单的页眉内容（与 footerContent 一起使用，当 isHtml/isHtmlMode 控制格式时）"Company Name"
页脚内容String简单的页脚内容"Page PAGE of NUMPAGES"
isHtmlBoolean页眉/页脚内容是否 HTMLtrue
isHtmlModeBoolean使用 HTML 内容处理模式true
allPagesHeaderHtmlString标题 HTML 适用于所有页面。支持。 PAGE， NUMPAGES， SECTION， SECTIONPAGES"<div style='text-align: center;'>Company Name</div>"
firstPageHeaderHtmlString标题 HTML 仅限首页"<div style='text-align: center;'>Title Page</div>"
evenPagesHeaderHtmlString标题 HTML 对于偶数页"<div style='text-align: right;'>Book Title</div>"
oddPagesHeaderHtmlString标题 HTML 奇数页"<div style='text-align: left;'>Chapter Title</div>"
allPagesFooterHtmlString页脚 HTML 所有页面"Page PAGE of NUMPAGES"
firstPageFooterHtmlString页脚 HTML 仅限首页"<div style='text-align: center;'>Confidential</div>"
evenPagesFooterHtmlString页脚 HTML 偶数页"<div style='text-align: center;'>Page PAGE</div>"
oddPagesFooterHtmlString页脚 HTML 奇数页"<div style='text-align: center;'>Page PAGE</div>"

可选参数（带类型的页眉/页脚）​

范围类型描述例子
所有页面标题Object所有页面的页眉内容（HeaderFooterContentInUpdate）-
第一页标题Object首页的标题文字-
页面标题 / oddPagesHeaderObject奇数/偶数页的打印页眉-
所有页面页脚 / 首页页脚 / 甚至页面页脚 / 奇数页脚Object每页页脚内容类型-

可选参数（常规）​

范围类型描述例子
文化名称String文档处理的区域性代码（例如，“en-US”、“fr-FR”、“de-DE”）。默认值：null。影响文档语言和格式。en-US

HTML 内容支持​

这 API 支持 HTML 所有页眉和页脚参数中的内容：

  • HTML 标签： 标准 HTML 标签（div、span、p、b、i、u 等）
  • CSS样式：用于格式化的内联 CSS 样式
  • 纯文本纯文本会自动应用专业的默认样式
  • 混合内容： 结合 HTML 以及根据需要生成的纯文本

纯文本的默认样式：

  • 标题左对齐，底部边框，10px 字体
  • 页脚居中对齐，上边框，9px 字体

页面布局选项​

这 API 支持不同的页眉和页脚页面布局：

布局类型描述必需参数
所有页面所有页面使用相同的页眉/页脚allPagesHeaderHtml， allPagesFooterHtml （或键入） allPagesHeader， allPagesFooter）
首页首页页眉/页脚不同firstPageHeaderHtml， firstPageFooterHtml （或等效的文字描述）
单双页偶数页和奇数页使用不同的页眉/页脚。evenPagesHeaderHtml， oddPagesHeaderHtml， evenPagesFooterHtml， oddPagesFooterHtml （或等效的文字描述）

输出​

这 PDF4me 更新页眉和页脚 REST API 返回一个 JSON 回应。成功后 API 返回 Word 文档。 Base64编码字符串 在 document 场地 （ApiV2WordApiCallRes），而不是二进制数据。

成功响应

状态码： 200 OK

内容类型： application/json

回复正文：

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

回复字段：

  • 文档 （string）：已更新页眉和页脚的 Word 文档，编码为 Base64
  • 文件名 （string输出的 Word 文件名
  • 成功 （boolean手术是否成功
  • 错误信息 （string）：如果成功为假，则显示错误消息；否则为空

使用方法：

  1. 查看 success；如果为真，则提取 document 来自该领域的 JSON 回复
  2. 解码 Base64 获取二进制 Word 文档数据的字符串
  3. 使用以下命令保存或处理 Word 文件 fileName

示例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const base64 = data.document;
const binary = atob(base64);
const blob = new Blob([binary], { type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = data.fileName;
a.click();

请求示例​

标题​

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",
 "allPagesHeaderHtml": "<div style='text-align: center;'>Company Name</div>",
 "allPagesFooterHtml": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

进阶示例（首页 + 偶数/奇数页）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "firstPageHeaderHtml": "<div style='text-align: center;'>Title Page</div>",
 "firstPageFooterHtml": "<div style='text-align: center;'>Confidential</div>",
 "oddPagesHeaderHtml": "<div style='text-align: left;'>Chapter Title</div>",
 "evenPagesHeaderHtml": "<div style='text-align: right;'>Book Title</div>",
 "oddPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "evenPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "cultureName": "en-US"
}

HTML 内容示例：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center; color: #333; font-size: 12px; border-bottom: 1px solid #ccc; padding-bottom: 5px;'>Company Name | Department</div>",
 "allPagesFooterHtml": "<div style='text-align: center; color: #666; font-size: 9px; border-top: 1px solid #ccc; padding-top: 5px;'>Page PAGE of NUMPAGES | © 2024 Company Name</div>",
 "cultureName": "en-US"
}

纯文本示例（页眉内容/页脚内容）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "headerContent": "Company Name",
 "footerContent": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

代码示例​

这 PDF4me 更新页眉和页脚 REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言：

C# （CSharp） 样本

完全的 C# 实现 Word 文档中更新页眉和页脚的功能：

行业应用案例及应用​

法律及专业服务用例

  • 合同标题添加保密声明和法律免责声明
  • 法庭文件包括案件编号和立案信息
  • 法律简报添加律师信息和案件详情
  • 合规报告：包含监管信息和日期

获取帮助​

Get Your API KeyAPI SamplesGetting Started