向 PDF 添加表单字段 - 交互式表单 API

PDF4me 向 PDF 添加表单字段 允许您添加交互式表单字段 PDF 文件。这 API 服务流程 PDF 文件会在指定页面的特定位置添加表单字段（文本框和复选框）。 API 接收 PDF 通过内容和表单字段参数 REST API 利用电话 Base64 编码确保传输安全。该解决方案支持灵活定位、自定义字段类型和页面定位，是文档自动化和交互式应用的理想之选。 PDF 开发工作流程。

相关博客文章

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

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

访问博客 →

验证您的 API 请求

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

Get your api Key

主要特点

• 表单字段类型向表单添加文本框和复选框字段 PDF 文件
• 精确定位：通过精确的 X 和 Y 坐标控制场地位置
• 自定义字段尺寸调整表单字段尺寸以符合设计要求
• 灵活的页面定位将表单字段应用于特定页面或整个文档
• 初始值设置表单字段的默认值
• Base64 编码：使用安全文件内容传输 Base64 编码
• 简单的 API 一体化RESTful API 专为自动化而设计 PDF 表单创建工作流程

REST API 端点

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

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

REST API 参数

“向 PDF 添加表单字段”功能的完整参数列表 REST API参数按类别组织，以便更好地理解和实施。

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

必需参数

范围	类型	描述	例子
文档内容*	Base64	输入的内容 PDF 文件编码为 Base64	JVBERi...
文档名称*	String	来源 PDF 文件名带有 .pdf 扩展名	output.pdf
初始值*	String	表单字段的初始值	New input text
位置 X*	Integer	表单字段在页面上的 X 坐标	300
Y 位置*	Integer	表单字段在页面上的 Y 轴位置	300
字段名*	String	表单字段名称	Input Field Name
尺寸*	Integer	表单字段的大小	4
页面*	String	页面选项：“1”表示第1页，“1,3,5”表示特定页码，“2-5”表示页码范围，“1,3,7-10”表示混合页码，“1-”表示从第1页到最后一页	1
表单字段类型*	String	表单字段类型： 文本框 或者 复选框	TextBox

可选参数

范围	类型	描述	例子
异步	Boolean	启用异步处理。 true， 这 API 返回 202 状态并提供轮询 URL 在位置标题中	true

输出

这 PDF4me 向 PDF 添加表单字段 REST API 根据处理模式的不同，会返回不同的响应。 API 返回 PDF 作为 二进制数据 用于同步处理或提供轮询 URL 用于异步处理。

Success Response

同步处理（默认）

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

状态码： 200 OK

内容类型： application/pdf 或者 application/octet-stream

回复正文：

这 API 返回 PDF 直接以二进制数据格式（而非）文件形式保存 JSON）。

使用方法：

1. 响应体包含二进制数据 PDF 数据
2. 将响应内容直接保存为 PDF 文件
3. 不 Base64 二进制响应需要解码

示例（JavaScript）：

const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly

Asynchronous Processing

异步处理

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

状态码： 202 Accepted

响应头：

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

投票过程：

1. 提取 Location 来自 202 响应的标头
2. 民意调查 URL 使用 GET 请求
3. 继续轮询，直到收到 200 OK 地位
4. 最终响应包含二进制数据 PDF 数据

轮询示例：

// 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 pdfBlob = await pollResponse.blob();
    // Process binary PDF
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

错误响应

状态码	描述	示例回答
400 Bad Request	请求参数无效或缺少必填字段	{"error": "Missing required parameter: fieldName"}
401 Unauthorized	无效或缺失 API 钥匙	{"error": "Unauthorized"}
500 Internal Server Error	处理过程中出现服务器错误	{"error": "Internal server error"}

Response Format Details

了解反应

• 同步（200）返回二进制数据 PDF 数据直接
• 异步（202）返回用于轮询的 Location 标头，最终响应为二进制数据。 PDF
• 不 JSON 包装纸： 这 API 返回 PDF 作为二进制文件，未封装 JSON 和 Base64 编码

请求示例

标题

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

笔记： 这 API 关键必须是 Base64 已编码。获取您的 API 钥匙 PDF4me 仪表板

有效载荷

{
  "docContent": "Please put PDF base64 content",
  "docName": "output.pdf",
  "initialValue": "input text",
  "positionX": 300,
  "positionY": 300,
  "fieldName": "Input Field Name",
  "Size": 4,
  "pages": "1",
  "formFieldType": "TextBox"
}

代码示例

这 PDF4me 向 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 Apps Script 样本

Google Apps Script 实施 Google Workspace 一体化：

View Google Script Sample

AWS Lambda

AWS Lambda 样本

无服务器 AWS Lambda 函数实现：

View AWS Lambda Sample

表单字段创建功能

表单字段类型

• 文本框字段创建用于用户数据输入和表单填写的文本输入字段
• 复选框字段添加复选框元素，用于选择和确认选项
• 定制尺寸调整字段尺寸以满足设计要求和内容需求
• 专业成果高质量、功能精准的表单字段创建
• 高级处理支持复杂的表单布局和字段排列

定位和布局

• 精确坐标：通过精确的 X 和 Y 位置值控制字段放置
• 灵活定位支持任意页面位置和字段排列
• 页面定位将表单字段应用于特定页面或整个文档
• 定制尺寸可调节的场地尺寸，以实现最佳的形状设计
• 专业布局在所有目标页面上保持一致的表单字段位置

高级功能

• 初始值设置默认字段值以改善用户体验
• 字段命名：用于表单数据收集和处理的自定义字段名称
• 专业创作高质量表单字段生成，功能清晰
• 灵活选项：可根据特定要求自定义表单字段参数

行业应用案例及应用

Legal & Professional Services

法律及专业服务用例

• 合同表格：在合同和协议中添加用于数字签名的表单字段
• 法律文件创建用于法律文件处理的交互式表单
• 合规表格构建符合监管要求和文档要求的表单
• 客户接待创建法律服务客户信息登记表

Healthcare & Medical

医疗保健应用案例

• 患者表格创建交互式患者登记表和病史表
• 医疗文件：构建医疗记录和文档表格
• 保险索赔：设计保险索赔处理表格
• 同意书：创建医疗程序的知情同意书和授权书

Finance & Banking

金融与银行业应用案例

• 金融应用：构建贷款和信贷申请表
• 开户创建用于开户和 KYC 流程的表格
• 交易表格：设计金融交易和处理表格
• 合规文件创建监管合规报告表格

Human Resources

人力资源应用案例

• 应用程序处理：构建求职申请和注册申请表
• 员工入职创建员工入职和文档表格
• 创建调查问卷设计交互式调查和问卷 PDF 格式
• 绩效考核构建绩效评估和反馈表单

Business & Enterprise

商业及企业应用案例

• 文档自动化创建用于数据收集和处理的交互式表单
• 数据收集创建用于收集客户信息和反馈的表单
• 交互式文档向现有表单添加字段 PDFs 为了增强用户参与度
• 业务流程自动化创建用于自动化业务工作流程和数据录入的表单

获取帮助

Get Your API KeyAPI SamplesGetting Started