添加图像印章 PDF 水印 API
PDF4me 添加图像印章 PDF 使您能够添加可自定义的图像图章和水印 PDF 文件。这 API 服务流程 PDF 文件并添加图像水印,支持精确定位、自定义尺寸和格式设置,用于文档品牌化和安全性。 API 接收 PDF 通过内容和图像数据 REST API 利用电话 Base64 采用编码实现安全传输。该解决方案支持灵活定位、自定义尺寸、页面定位和打印控制,是文档品牌化、版权保护和企业应用的理想之选。 PDF 工作流程。
验证您的身份 API 要求
要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份。 REST API。
主要特点
- 图片水印支持添加自定义图像作为水印和图章 PDF 文件
- 灵活定位:以像素级精度控制水平和垂直对齐。
- 定制尺寸使用毫米和像素两种单位调整图像尺寸
- 高级格式设置设置不透明度、边距和背景选项,以获得专业外观。
- 页面定位将印章贴到特定页面或整个文档上
- 打印控制配置图章仅在打印或屏幕上显示
- 专业成果创建图像水印,增强文档安全性和品牌形象
- 无缝的 API 一体化: REST API 专为自动化而设计 PDF 编辑工作流程和企业系统集成
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有图像印章添加操作均通过单个端点执行:
- 方法: POST
- 终点:
/api/v2/ImageStamp
图像盖章功能
图像格式支持
- 常用格式支持 JPG, PNG、GIF 和其他标准图像格式
- Base64 编码:通过安全图像传输 Base64 编码
- 尺寸控制提供毫米(10-200毫米)和像素(20-600像素)两种尺寸选项
定位和布局
- 水平对齐:左侧、中间或右侧定位选项
- 垂直对齐:顶部、中部或底部放置控制
- 利润控制:可进行毫米级(0-100毫米)和像素级(0-300像素)的精确定位测量
- 页面定位:使用页面选项应用于特定页面(空字符串表示所有页面,“1”,“1,3,5”,“2-5”,“1,3,7-10”,“2-”)
高级功能
- 不透明度控制可调节透明度(0-100):0=完全不可见,100=完全不透明
- 后台模式:可选择将图像放置在后面(
isBackground: true)或在前面(isBackground: false内容 - 打印控制配置印章仅在打印时显示(
showOnlyInPrint: true)或在视图和打印中(showOnlyInPrint: false) - 异步处理支持对长时间运行的操作进行轮询的异步处理
REST API 参数
添加图像图章的完整参数列表 PDF REST API参数按类别组织,以便更好地理解和实施。
重要的: 标有星号 (*) 的参数为必填项,必须提供。 API 正常运作。
必需参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 文档名称* | String | 输出 PDF 文件名带有 .pdf 扩展名 | output.pdf |
| 文档内容* | Base64 | 输入的内容 PDF 文件编码为 Base64 | JVBERi... |
| 图像名称* | String | 带扩展名的图像文件名称(例如,.png、.jpg) | stamp.png |
| 图像文件* | Base64 | 图像文件内容编码为 Base64 格式 | iVBORw0KGgoAAAANS... |
| alignX* | String | 水平对齐方式: 左边, 中心, 或者 正确的 | Center |
| alignY* | String | 垂直对齐: 顶部, 中间, 或者 底部 | Middle |
可选参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 页面 | String | 页面选项:空字符串表示所有页面, "1" 第 1 页, "1,3,5" 针对特定页面, "2-5" 对于页面范围, "1,3,7-10" 混合型, "2-" 从第2页到结尾页 | "" 或者 "1-3" |
| 身高(毫米) | String | 图片高度(毫米)(10-200) | 30 |
| 宽度(毫米) | String | 图片宽度(毫米)(10-200) | 30 |
| 高度(像素) | String | 图片高度(像素)(20-600) | 85 |
| widthInPx | String | 图片宽度(像素)(20-600) | 85 |
| marginXInMM | String | 水平边距(毫米)(0-100) | 10 |
| marginYInMM | String | 垂直边距(毫米)(0-100) | 10 |
| marginXInPx | String | 水平边距(像素,0-300) | 28 |
| marginYInPx | String | 垂直边距(像素,0-300) | 28 |
| 不透明度 | Integer | 不透明度级别(0-100):0=完全不可见,100=完全不透明 | 50 |
| 是背景 | Boolean | 将印章放置在背景(是)或前景(否) | true |
| 仅在印刷版中显示 | Boolean | 仅在打印时显示(是)或同时在视图和打印时显示(否) | false |
| 异步 | Boolean | 启用异步处理。 true, 这 API 返回 202 状态并提供轮询 URL 在 Location 标题 | true |
输出
这 PDF4me 添加图像印章 PDF REST API 根据处理模式的不同,会返回不同的响应。 API 返回 PDF 作为一个 Base64-编码字符串 JSON 格式不是二进制数据。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同步处理(默认)
什么时候 async 未设置或已设置为 false, 这 API 立即处理请求:
状态码: 200 OK
Content-Type: application/json
回复正文:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
回复字段:
- 文档名称 (字符串):输出 PDF 文件名
- 文档内容 (字符串): PDF 文件已应用图像印章,编码为 Base64 细绳
使用方法:
- 提取
docContent来自该领域的 JSON 回复 - 解码 Base64 获取二进制文件的字符串 PDF 数据
- 保存或处理 PDF 根据需要归档
例子 (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
异步处理
什么时候 async: true 已设定, API 异步处理请求:
状态码: 202 Accepted
响应头:
Location: https://api.pdf4me.com/api/v2/ImageStamp/poll/12345-abcde-67890
投票过程:
- 提取
Location来自 202 响应的标头 - 民意调查 URL 使用 GET 请求
- 继续轮询,直到收到 200 OK 地位
- 最终回复包含相同的内容。 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
}
错误响应
这 API 退货标准 HTTP 错误代码及错误详情:
- 无效的请求参数
- 缺少必填字段
文档名称,文档内容,图像名称,图像文件,alignX,alignY) - 无效的 Base64 编码
文档内容或者图像文件 - 无效的对齐方式值(alignX 必须为 Left/Center/Right,alignY 必须为 Top/Middle/Bottom)
- 尺寸或边距值无效(超出允许范围)
- 无效或缺失 API 钥匙
- API 钥匙未正确 Base64 编码 Authorization 标题
- 丢失的
授权方式:基本标题
- 服务器端处理错误
- PDF 处理失败
- 图像印章应用失败
错误响应格式:
{
"error": "Error message describing what went wrong"
}
回复格式详情
重要的: 这 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==",
"imageName": "stamp.png",
"imageFile": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"alignX": "Center",
"alignY": "Middle"
}
高级示例(包含所有可选字段):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"imageName": "stamp.png",
"imageFile": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"alignX": "Center",
"alignY": "Middle",
"pages": "",
"heightInMM": "30",
"widthInMM": "30",
"heightInPx": "85",
"widthInPx": "85",
"marginXInMM": "10",
"marginYInMM": "10",
"marginXInPx": "28",
"marginYInPx": "28",
"opacity": 50,
"isBackground": true,
"showOnlyInPrint": false,
"async": true
}
代码示例
这 PDF4me 添加图像印章 PDF REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
行业应用案例及应用
- Legal & Professional Services
- Business & Enterprise
- Finance & Banking
- Government & Compliance
法律及专业服务用例
- 法律文件将法律免责声明和保密声明应用于法律文件
- 合同盖章在合同和协议中添加图像印章
- 保密声明在敏感法律文件上加贴保密图像印章
- 合规印章在法律文件中添加合规性图像通知
商业及企业应用案例
- 文档品牌化在 PDF 文档中添加公司徽标、水印和品牌元素
- 状态指示器添加“草稿”、“机密”或“已批准”图像印章以指示文档状态
- 报告生成向生成的文档添加时间戳、页码和报告标识符
- 企业品牌在所有业务文档中应用一致的品牌形象
金融与银行业应用案例
- 财务报告在财务报告和报表中添加图像印章
- 发票盖章:在发票和采购订单上添加审批图像印章
- 合规文件在财务文件上添加监管图像印章
- 审计跟踪在财务文档上创建带有图像时间戳的审计跟踪
政府及合规应用案例
- 版权保护使用版权声明和所有权图像印章来保护知识产权
- 监管合规添加合规图像印章以满足监管要求
- 官方文件在政府文件上加盖官方图像印章
- 公共记录为公共记录和文件添加分类图像印章