PDF API 参考
ComPDF Self-hosted PDF 工具接口参考。
PDF API 按页面编辑、PDF 规范、PDF 安全和 PDF 高级能力拆分。所有 PDF 工具接口都需要在请求头中传入 x-api-key。
| 功能 | 请求地址 | 说明 |
|---|---|---|
| PDF 合并 API | /api/v1/process/pdf/merge | 按上传顺序将多个 PDF 文件合并为一个 PDF。 |
| PDF 拆分 API | /api/v1/process/pdf/split | 将 PDF 拆分并返回 ZIP 结果包。 |
| PDF 提取 API | /api/v1/process/pdf/extract | 从 PDF 中提取指定页面并生成新的 PDF。 |
| 插入 PDF 页面 API | /api/v1/process/pdf/insert-from-pdf | 将另一个 PDF 的页面插入到主 PDF 中。 |
| 插入空白页 API | /api/v1/process/pdf/insert-blank | 向 PDF 中插入空白页面。 |
| PDF 删除页面 API | /api/v1/process/pdf/delete | 删除 PDF 中的指定页面。 |
| PDF 旋转页面 API | /api/v1/process/pdf/rotate | 旋转 PDF 中的指定页面。 |
| PDF 规范转换 API | /api/v1/process/pdf/pdfa | 按私有化 SDK 支持的配置将 PDF 转换为 PDF/A、PDF/X、PDF/E、PDF/UA 等规范格式。 |
| PDF 加密 API | /api/v1/process/pdf/encrypt | 加密 PDF，并可设置权限。 |
| PDF 解密 API | /api/v1/process/pdf/decrypt | 解密受密码保护的 PDF。 |
| 添加水印 API | /api/v1/process/pdf/watermark/add | 向 PDF 添加文字或图片水印。 |
| 移除水印 API | /api/v1/process/pdf/watermark/remove | 从 PDF 中移除水印。 |
| PDF 压缩 API | /api/v1/process/pdf/compress | 压缩并优化 PDF。 |
公共规则
| 项目 | 说明 |
|---|---|
| 认证 | 请求头：x-api-key: your_api_key_here。 |
| 请求类型 | multipart/form-data。 |
| 参数对象 | request 是 JSON 字符串；若省略 request，ComPDF Self-hosted 会转发剩余非文件字段。 |
| 结果 | 成功时直接返回文件流。 |
请求示例
bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/merge" \
-H "x-api-key: your_api_key_here" \
-F "files=@/path/to/a.pdf" \
-F "files=@/path/to/b.pdf" \
-F 'request={"outputFileName":"merged.pdf"}'