添加 HTML 页眉页脚 PDF 品牌推广 API

PDF4me 添加 HTML 页眉页脚 PDF 使您能够添加 HTML 内容可以作为页眉、页脚或两者兼有。 PDF 文件。这 API 服务流程 PDF 文件和添加 HTML 内容定位精准，支持自定义边距和页面定位选项，方便文档品牌化和组织。 API 接收 PDF 内容和 HTML 通过数据 REST API 利用电话 Base64 安全编码 PDF 传输。支持 HTML 凭借内容定制、灵活定位、自定义边距、页面定位和首页排除等功能，此解决方案非常适合文档品牌化、报表生成和企业级应用。 PDF 工作流程。

相关博客文章

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

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

访问博客 →

验证您的身份 API 要求

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

Get your api Key

主要特点

• HTML 内容支持添加丰富的 HTML 内容以页眉和页脚的形式呈现，并提供完整的样式支持
• 灵活定位：通过精确的边距控制来控制页眉和页脚的位置
• 定制造型： 满的 HTML 和 CSS 支持专业形象
• 页面定位将页眉和页脚应用于特定页面或整个文档
• 跳过第一页：可选择从首页排除页眉和页脚
• 专业成果创建能够增强文档组织性和品牌形象的页眉和页脚
• 无缝的 API 一体化： REST API 专为自动化而设计 PDF 编辑工作流程和企业系统集成

REST API 端点

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

• 方法： POST
• 终点： /api/v2/AddHtmlHeaderFooter

页眉页脚功能

HTML 内容支持

• HTML 内容支持 HTML 包含内联内容 CSS 造型
• 定制造型使用内联 CSS 字体、颜色、对齐方式和基本样式
• 文字和图片支持 HTML 文本内容和嵌入图像
• 清楚的 HTML 细绳： HTML 内容必须以纯字符串形式提供（而非 Base64 （已编码）

定位和布局

• 利润控制：基于像素的精确定位（左边距、右边距、上边距、下边距）
• 页面定位：使用页面选项应用于特定页面（空字符串表示所有页面，“1”，“1,3,5”，“2-5”，“1,3,7-10”，“2-”）
• 跳过第一页：可选择从首页排除页眉和页脚
• 位置选项添加内容为页眉、页脚或两者都添加

高级功能

• 异步处理支持对长时间运行的操作进行轮询的异步处理
• 专业形象文档格式和样式保持一致
• 灵活定位：通过精确的像素尺寸控制页眉和页脚的位置

REST API 参数

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

重要的： 标有星号 (*) 的参数为必填项，必须提供。 API 正常运作。

必需参数

范围	类型	描述	例子
文档名称*	String	输出 PDF 文件名带有 .pdf 扩展名	output.pdf
文档内容*	Base64	输入的内容 PDF 文件编码为 Base64	JVBERi...
html内容*	String	HTML 内容（纯文本） HTML 要添加为页眉或页脚的字符串（非 base64 编码）	<div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div>
地点*	String	位置 HTML 内容： 标题， 页脚， 或者 两个都	Header

可选参数

范围	类型	描述	例子
页面	String	页面选项：空字符串表示所有页面， "1" 第 1 页， "1,3,5" 针对特定页面， "2-5" 对于页面范围， "1,3,7-10" 混合型， "2-" 从第2页到结尾页	"" 或者 "1-3"
跳过第一页	Boolean	跳过第一页（真）或包含第一页（假）	false
左边距	双倍的	左边距（像素）	20.0
右边距	双倍的	右边距（像素）	20.0
顶部边距	双倍的	顶部边距（像素）	50.0
底部边距	双倍的	底部边距（像素）	50.0
异步	Boolean	启用异步处理。 true， 这 API 返回 202 状态并提供轮询 URL 在 Location 标题	true

重要提示： 这 htmlContent 参数必须是 清楚的 HTML 细绳， 不是 Base64 已编码。您可以包含内联 CSS 造型设计 HTML。

输出

这 PDF4me 添加 HTML 页眉页脚 PDF REST API 根据处理模式的不同，会返回不同的响应。 API 返回 PDF 作为一个 Base64-编码字符串 JSON 格式不是二进制数据。

Success Response

同步处理（默认）

什么时候 async 未设置或已设置为 false， 这 API 立即处理请求：

状态码： 200 OK

Content-Type： application/json

回复正文：

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}

回复字段：

• 文档名称 （字符串）：输出 PDF 文件名
• 文档内容 （字符串）： PDF 文件 HTML 已应用页眉/页脚，编码为 Base64 细绳

使用方法：

1. 提取 docContent 来自该领域的 JSON 回复
2. 解码 Base64 获取二进制文件的字符串 PDF 数据
3. 保存或处理 PDF 根据需要归档

例子 （JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes

Asynchronous Processing

异步处理

什么时候 async: true 已设定， API 异步处理请求：

状态码： 202 Accepted

响应头：

Location: https://api.pdf4me.com/api/v2/AddHtmlHeaderFooter/poll/12345-abcde-67890

投票过程：

1. 提取 Location 来自 202 响应的标头
2. 民意调查 URL 使用 GET 请求
3. 继续轮询，直到收到 200 OK 地位
4. 最终回复包含相同的内容。 JSON 格式 docName 和 docContent （Base64）

轮询示例：

// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');

// Poll until complete
while (true) {
  const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
  if (pollResponse.status === 200) {
    const data = await pollResponse.json();
    // Process data.docContent (Base64 PDF)
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

错误响应

这 API 退货标准 HTTP 错误代码及错误详情：

400 Bad Request

• 无效的请求参数
• 缺少必填字段文档名称， 文档内容， html内容， 地点）
• 无效的 Base64 编码 文档内容
• 无效的位置值（必须是：页眉、页脚或两者）
• 无效的 HTML 内容

401 Unauthorized

• 无效或缺失 API 钥匙
• API 密钥不正确 Base64 编码 Authorization 标题
• 丢失的 授权方式：基本 标题

500 Internal Server Error

• 服务器端处理错误
• PDF 处理失败
• HTML 渲染失败

错误响应格式：

{
  "error": "Error message describing what went wrong"
}

Response Format Details

回复格式详情

重要的： 这 API 总是返回 JSON绝非二元 PDF 直接传输数据。

响应结构：

{
  "docName": "string",      // Output PDF filename
  "docContent": "string"    // Base64-encoded PDF content
}

Content-Type 标题：

• 成功： application/json
• 这 PDF 嵌入为 Base64 字符串内部 JSON 回复

为什么 Base64？

• JSON-二进制数据的安全编码
• 易于传输 HTTP
• 与所有编程语言兼容
• 可以直接嵌入 JSON 不回避问题

解码 Base64 到 PDF：

JavaScript/Node.js：

const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js

Python：

import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
    f.write(pdf_bytes)

C#：

byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);

请求示例

标题

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

笔记：

• 获得你的 API 钥匙 PDF4me 仪表板
• 这 API 关键必须是 Base64 编码后以“Basic”为前缀 Authorization 标题
• 例如：如果你的 API 关键是 abc123将其编码为 Base64 并使用 Authorization: Basic YWJjMTIz

有效载荷

基本示例（仅必填字段）：

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header"
}

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

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header",
  "pages": "",
  "skipFirstPage": false,
  "marginLeft": 20.0,
  "marginRight": 20.0,
  "marginTop": 50.0,
  "marginBottom": 50.0,
  "async": true
}

重要的： 这 htmlContent 字段必须包含 清楚的 HTML 作为字符串， 不是 Base64 已编码。您可以使用内联 CSS 造型设计 HTML 标签。

代码示例

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

C#

C# (CSharp) 示例

完全的 C# 实现向页面添加页眉和页脚的功能 PDF：

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

商业及企业应用案例

• 文档品牌化向 PDF 文档添加公司徽标、页眉和页脚
• 报告生成为生成的报告添加统一的页眉和页脚
• 商业文件使用品牌化的页眉和页脚提升专业形象
• 企业品牌在所有业务文档中应用一致的页眉和页脚。

Education & Research

教育与研究应用案例

• 学术论文为学术出版物添加页码、页眉和页脚
• 研究文件：使用正确的页眉和页脚格式化研究论文
• 论文格式为论文和学位论文添加页眉和页脚
• 教育材料利用页眉和页脚增强教育文档

Finance & Banking

金融与银行业应用案例

• 财务报告为财务报告和报表添加页眉和页脚
• 发票格式为发票和财务文件添加页眉和页脚
• 合规文件在页眉和页脚中包含合规信息
• 审计报告为审计报告添加专业的页眉和页脚

获取帮助

Get Your API KeyAPI SamplesGetting Started