文件处理接口
ComPDF Self-hosted 通过 /api/v1 提供文件处理能力。受保护的文件处理接口都需要请求头 x-api-key。
接口类型
| 类型 | 请求地址 | 成功响应 |
|---|---|---|
| 同步转档接口 | POST /api/v1/process/{source}/{target} | 结果文件流 |
| 同步 PDF 工具接口 | POST /api/v1/process/pdf/{operation} | 结果文件流 |
| 同步生成 PDF 接口 | POST /api/v1/process/pdf/generation/{operation} | 结果 PDF 文件流 |
| 创建异步任务 | POST /api/v1/task/{source}/{target} | 带 taskId 和 status 的 JSON envelope |
| 查询任务状态 | GET /api/v1/task/{id} | 带任务信息的 JSON envelope |
| 下载任务结果 | GET /api/v1/task/{id}/download | 结果文件流 |
请求示例
同步 PDF 转 Word：
bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/docx" \
-H "x-api-key: your_api_key_here" \
-F "[email protected]" \
-F 'options={"pageRanges":"1-3"}' \
-o result.docx同步 PDF 合并：
bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/merge" \
-H "x-api-key: your_api_key_here" \
-F "[email protected]" \
-F "[email protected]" \
-F 'request={"pageRanges":["all","all"]}' \
-o merged.pdf创建异步任务：
bash
curl -X POST "http://localhost:8080/api/v1/task/pdf/docx" \
-H "x-api-key: your_api_key_here" \
-F "[email protected]" \
-F 'options={"pageRanges":"1-3"}'JSON 成功响应
创建异步任务和查询任务接口返回 JSON envelope：
json
{
"code": 200,
"msg": "success",
"data": {
"taskId": "7fdc1fb6-1f4d-4b5c-88d6-4b4c4c1e8f44",
"status": "pending"
}
}同步结果接口直接返回二进制文件流，并携带 Content-Type 与 Content-Disposition 响应头。