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

符号 PDF 数字签名 API

PDF4me 符号 PDF 允许您添加签名图片 PDF 可控制文档的位置、大小和外观。 API 服务流程 PDF 文件并添加签名图像 Base64 用于安全传输的编码。 API 接收 PDF 通过内容和签名图像数据 REST API 通话。此解决方案非常适合文档认证、法律合规性、业务流程以及为文档添加视觉签名。

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

验证您的身份 API 要求​

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

Get your api Key

主要特点​

  • 图像签名支持添加自定义签名图片 PDF 可完全控制位置和尺寸的文档
  • 灵活定位：以像素级精度控制水平和垂直对齐。
  • 定制尺寸使用毫米和像素两种单位调整签名尺寸
  • 高级格式设置设置不透明度、边距和背景选项，以获得专业外观。
  • 页面定位将签名应用于特定页面或整个文档
  • 打印控制配置签名仅在打印或屏幕上显示
  • 专业成果创建可增强文档认证和安全性的签名
  • 异步处理支持对长时间运行的操作进行轮询的异步处理

REST API 端点​

这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。全部 PDF 签名操作通过单个端点执行：

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

支持 PDF 签名功能​

这 API 为各种 PDF 签名能力：

签名图像支持​

  • 常用格式支持 JPG， PNG以及其他标准图像格式
  • Base64 编码：通过安全方式传输签名 Base64 编码
  • 灵活尺寸提供毫米（10-200毫米）和像素（20-600像素）两种尺寸选项
  • 质量保持：保持标志性图像质量 PDF 输出

定位和布局​

  • 水平对齐：左侧、中间和右侧定位选项
  • 垂直对齐：顶部、中部和底部位置控制
  • 利润控制：基于毫米（0-100毫米）和像素（0-300像素）的精确定位测量
  • 灵活就业支持任何页面位置的精确测量
  • 页面定位：应用于特定页面或整个文档（可选）

高级功能​

  • 不透明度控制：可调节透明度（0-100），实现低调或醒目的签名效果
  • 后台模式可选择将签名置于内容之前或之后。
  • 打印控制配置签名以在视图和打印中显示或仅打印。
  • 专业形象：清晰可见的高质量签名渲染

REST API 参数​

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

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

必需参数​

范围类型描述例子
文档名称*String输出 PDF 文件名带有 .pdf 扩展名output.pdf
文档内容*Base64PDF 文件内容以编码形式 Base64JVBERi...
图像文件*Base64签名图像文件内容编码 Base64iVBORw0KGgoAAAANSUhEUgAA...
图像名称*String签名图像文件名（带扩展名，例如 .jpg、.png）signature.jpg
alignX*String水平对齐方式： 左边， 中心， 或者 正确的Right
alignY*String垂直对齐： 顶部， 中间， 或者 底部Bottom

可选参数​

范围类型描述例子
页面String页面选项：“1”、“1,3,5”、“2-5”、“1,3,7-10”、“2-”。如果未指定，则适用于所有页面。1-3
宽度（毫米）String签名宽度（毫米）（10-200）50
身高（毫米）String签名高度（毫米）（10-200）25
宽度（像素）String签名宽度（像素）（20-600）142
高度（像素）String签名高度（像素）（20-600）71
marginXInMMString水平边距（毫米）（0-100）20
marginYInMMString垂直边距（毫米）（0-100）20
marginXInPxString水平边距（像素，0-300）57
marginYInPxString垂直边距（像素，0-300）57
不透明度String不透明度（0-100）：0=完全不可见，100=完全不透明100
仅在印刷版中显示Boolean显示签名并打印（是）或仅打印（否）true
是背景Boolean将签名置于背景（真）或前景（假）false
异步Boolean启用异步处理。 true， 这 API 返回 202 状态并提供轮询 URL 在 Location 标题true

输出​

这 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==",
  "imageFile": "iVBORw0KGgoAAAANSUhEUgAA...",
  "imageName": "signature.jpg",
  "alignX": "Right",
  "alignY": "Bottom"
}

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

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "imageFile": "iVBORw0KGgoAAAANSUhEUgAA...",
  "imageName": "signature.jpg",
  "pages": "1-3",
  "alignX": "Right",
  "alignY": "Bottom",
  "widthInMM": "50",
  "heightInMM": "25",
  "widthInPx": "142",
  "heightInPx": "71",
  "marginXInMM": "20",
  "marginYInMM": "20",
  "marginXInPx": "57",
  "marginYInPx": "57",
  "opacity": "100",
  "showOnlyInPrint": true,
  "isBackground": false,
  "async": true
}

代码示例​

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

C# (CSharp) 示例

完全的 C# 签名实施 PDF 文件：

PDF 签名功能​

签名图像控制​

  • 格式支持： JPG， PNG、GIF 和其他标准图像格式
  • 质量保持：保持签名图像的质量和分辨率 PDF 输出
  • Base64 编码：通过安全方式传输签名 Base64 编码
  • 灵活尺寸：提供毫米级和像素级两种尺寸选项
  • 专业形象：清晰可见的高质量签名渲染

定位和布局​

  • 对准控制精确的水平和垂直对齐选项
  • 边距设置：毫米级和像素级定位
  • 灵活就业支持任何页面位置和方向
  • 页面定位：应用于特定页面或整个文档
  • 尺寸控制可定制尺寸，以实现最佳摆放效果

高级功能​

  • 不透明度控制可调节透明度，实现低调或醒目的签名效果
  • 后台模式可选择将签名置于内容之前或之后。
  • 打印控制配置签名仅在打印或屏幕上显示
  • 专业成果创建可增强文档认证和安全性的签名
  • 灵活定位：以像素级精度控制水平和垂直对齐。

行业应用案例及应用​

法律及专业服务用例

  • 法律文件在法律合同、协议和官方文件上签名
  • 合同签署以电子方式签署合同和协议，以确保其法律效力。
  • 法庭文件将数字签名应用于法庭文件和法律文件
  • 合规要求满足文件签署和认证方面的监管要求

获取帮助​

Get Your API KeyAPI SamplesGetting Started