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

添加页码 PDF 分页 API

PDF4me 添加页码 PDF 允许您添加可自定义的页码 PDF 可控制位置、格式和样式的文档。 API 服务流程 PDF 文件并使用格式占位符添加页码 # 表示当前页码， {1} 代表总页数。 API 接收 PDF 通过内容 REST API 利用电话 Base64 用于安全传输的编码。此解决方案非常适合文档整理、法律文件、学术论文和企业级应用。 PDF 工作流程。

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

验证您的身份 API 要求​

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

获取您的 API 密钥

主要特点​

  • 灵活格式：可从多种页码格式中选择 # 当前页面和 {1} 总页数（例如，“# ） 1“， “页 ＃”）
  • 精确定位：以像素级精度控制水平和垂直对齐。
  • 定制造型调整字体大小、粗体、斜体和其他文本格式选项
  • 利润控制设置精确的边距（以毫米为单位），以获得最佳放置效果
  • 跳过第一页：可选择从首页排除页码
  • 专业成果在所有文档中创建一致、专业的页码。

REST API 端点​

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

  • 方法： 邮政
  • 终点： /api/v2/AddPageNumber

REST API 参数​

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

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

必需参数​

范围类型描述例子
文档名称*细绳输出 PDF 文件名带有 .pdf 扩展名output.pdf
文档内容*Base64PDF 文件内容以编码形式 Base64JVBERi...
页码格式*细绳页码格式。使用 # 当前页码 {1} 总页数。示例：“# 1“， “页 ＃”， ”＃ / 1“# of {1}
alignX*细绳水平对齐方式： 左边， 中心， 或者 正确的right
alignY*细绳垂直对齐： 顶部， 中间， 或者 底部bottom

可选参数​

范围类型描述例子
marginXinMM整数水平边距（距边缘的距离，单位：毫米，0-100）2
marginInMM整数垂直边距（毫米）（0-100）2
字体大小整数页码字体大小（8-72）12
冰球布尔值页码加粗（正确）或常规（错误）true
isItalic布尔值将页码设置为斜体（真）或正体（假）false
跳过第一页布尔值首页跳过页码（正确）或包含页码（错误）false
异步布尔值启用异步处理。 true， 这 API 返回 202 状态并提供轮询 URL 在 Location 标题true

页码格式占位符​

这 pageNumberFormat 参数使用以下占位符：

  • # - 替换为当前页码（1、2、3 等）
  • {1} - 替换为总页数

格式示例：

  • "# of {1}" → 显示“1/10”、“2/10”、“3/10”等。
  • "Page #" → 显示“第 1 页”、“第 2 页”、“第 3 页”等。
  • "# / {1}" → 显示“1/10”、“2/10”、“3/10”等。
  • "- # -" → 显示“-1-”、“-2-”、“-3-”等。
  • "[#/{1}]" → 显示“[1/10]”、“[2/10]”、“[3/10]”等。
  • "(#)" → 显示“（1）”、“（2）”、“（3）”等。
  • "#" → 仅显示页码：“1”、“2”、“3”等。

输出​

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

同步处理（默认）

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

状态码： 200 OK

Content-Type： application/json

回复正文：

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

回复字段：

  • 文档名称 （字符串）：输出 PDF 文件名
  • 文档内容 （字符串）： PDF 文件已添加页码，编码为 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

请求示例​

标题​

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==",
  "pageNumberFormat": "# of {1}",
  "alignX": "right",
  "alignY": "bottom"
}

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

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "pageNumberFormat": "# of {1}",
  "alignX": "right",
  "alignY": "bottom",
  "marginXinMM": 2,
  "marginYinMM": 2,
  "fontSize": 12,
  "isBold": true,
  "isItalic": false,
  "skipFirstPage": false,
  "async": true
}

代码示例​

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

C# (CSharp) 示例

完全的 C# 实现向……添加页码 PDF：

页码特征​

格式选项​

  • 多种格式支持多种编号样式和模式
  • 灵活定位精确控制页码位置
  • 定制造型完全控制字体外观和格式
  • 首页控件：可选择不将封面页纳入页码范围

文档增强​

  • 专业布局在所有文档中创建一致、专业的页码。
  • 打印优化：根据不同的打印要求优化页码
  • 数字发行在不同查看设备上保持格式一致
  • 品牌一致性：在各组织中采用统一的页码标准

高级功能​

  • 批量处理处理多个文档，并确保页码一致
  • 质量保证确保页码完整性和正确性 PDF 兼容性
  • 布局保留在添加页码的同时保持文档结构
  • 自定义边距精确控制页码位置

行业应用案例及应用​

法律及专业服务用例

  • 法律文件：合同、协议和法律文书中的页码
  • 法庭文件在法庭文件和法律文件中添加页码
  • 合规文件合规和监管文件中的页码
  • 客户文档整理客户文件并添加页码

获取帮助​

Get Your API KeyAPI SamplesGetting Started