增加边距 PDF - 布局格式化程序 API
PDF4me 增加边距 PDF 允许您在任意一侧添加自定义边距。 PDF 这份文件。这份文件 API 服务流程 PDF 文件会添加以毫米为单位的页边距,并相应地调整页面大小以适应页边距。 API 接收 PDF 通过内容 REST API 利用电话 Base64 用于安全传输的编码。此解决方案非常适合文档格式化、打印准备以及确保专业文档页面布局的一致性。
验证您的身份 API 要求
要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份。 REST API。
主要特点
- 个体利润控制分别设置上、下、左、右各边的边距
- 毫米级精度所有边距均以毫米为单位(0-100 范围)。
- 页面尺寸调整页面尺寸会自动调整以适应增加的边距。
- 文件保存:在调整布局的同时保持原始内容
- 异步处理支持对长时间运行的操作进行轮询的异步处理
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有边际附加操作均通过单个端点执行:
- 方法: POST
- 终点:
/api/v2/AddMargin
REST API 参数
“添加边距”功能的完整参数列表 PDF REST API参数按类别组织,以便更好地理解和实施。
重要的: 标有星号 (*) 的参数为必填项,必须提供。 API 正常运作。
必需参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 文档名称* | String | 输出 PDF 文件名带有 .pdf 扩展名 | output.pdf |
| 文档内容* | Base64 | PDF 文件内容以编码形式 Base64 | JVBERi... |
可选参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| 左边距 | Integer | 左边距,单位为毫米(0-100)。如果未指定,则不添加左边距。 | 20 |
| 右边距 | Integer | 右边距,单位为毫米(0-100)。如果未指定,则不添加右边距。 | 20 |
| 顶部边距 | Integer | 上边距,单位为毫米(0-100)。如果未指定,则不添加上边距。 | 25 |
| 底部边距 | Integer | 底部边距,单位为毫米(0-100)。如果未指定,则不添加底部边距。 | 25 |
| 异步 | 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/AddMargin/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 错误代码及错误详情:
- 无效的请求参数
- 缺少必填字段
文档内容,文档名称) - 无效的 Base64 编码
文档内容 - 无效的边距值(必须是 0 到 100 之间的整数)
- 无效或缺失 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=="
}
高级示例(包含所有可选字段):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"marginLeft": 20,
"marginRight": 20,
"marginTop": 25,
"marginBottom": 25,
"async": true
}
代码示例
这 PDF4me 增加边距 PDF REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
PDF 边距特征
利润控制
- 个人控制为文档的每一边(上、下、左、右)设置不同的边距
- 毫米级精度所有边距均以毫米为单位,范围为 0-100 毫米。
- 页面尺寸调整页面尺寸会自动调整以适应增加的边距。
- 布局保留调整页边距的同时保持文档结构
文档增强
- 打印优化确保文档在各种纸张尺寸上都能正确打印
- 专业格式:在各个团队中创建一致的文档布局
- 内容保存: 原来的 PDF 内容保持不变,同时增加边距。
行业应用案例及应用
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Publishing & Printing
法律及专业服务用例
- 法律文件确保符合法律文件格式标准
- 合同格式:以适当的边距格式化合同和协议
- 法庭文件准备符合标准页边距要求的法庭文件
- 合规文件:格式化合规文件,使其符合监管标准
教育与研究应用案例
- 学术论文:按出版要求格式化研究论文和学位论文
- 研究文件:为发表准备具有合适页边距的研究论文格式
- 论文格式:按照学术标准格式化论文和学位论文
- 教育材料:统一格式化教育文档的页边距
商业及企业应用案例
- 文档格式统一公司文件的页边距
- 商业报告创建布局一致的专业报告
- 演示材料增强演示文稿的视觉吸引力
- 公司文件将公司文档格式化为标准页边距
出版与印刷应用案例
- 印刷准备:针对特定打印要求优化 PDF
- 书籍排版:以适当的页边距排版书籍和出版物
- 杂志版面设计准备具有标准页边距的杂志版面
- 印刷制作:优化文档以满足印刷生产要求