插入空白页 API
向 PDF 中插入空白页面。
功能说明
ComPDF Self-hosted 通过 multipart/form-data 接收文件和 request JSON 字符串,并将参数转发给私有化 PDF SDK。成功时直接返回结果文件流。
同步执行
| 项目 | 值 |
|---|---|
| 认证 | x-api-key: your_api_key_here |
| 请求地址 | POST http://localhost:8080/api/v1/process/pdf/insert-blank |
| 请求类型 | multipart/form-data |
| 成功响应 | 结果文件流 |
请求参数
| 参数名 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
file | File | 源 PDF 文件。 | 是 |
request | String | JSON 字符串,包含下方 PDF SDK 参数。若省略 request,其他非文件 form-data 字段会作为 request 对象转发。 | 否 |
Request 参数
以下字段放入 request JSON 字符串中。
| 参数名 | 类型 | 作用 |
|---|---|---|
index | Number | 从 1 开始的插入位置。 |
count | Number | 需要插入的空白页数量。 |
width | Number | 空白页宽度,单位为 point。 |
height | Number | 空白页高度,单位为 point。 |
targetPassword | String | 主目标 PDF 的打开密码。 |
outputFileName | String | 可选输出文件名。传入后会作为首选下载文件名。 |
请求示例
bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/insert-blank" \
-H "x-api-key: your_api_key_here" \
-F "[email protected]" \
-F 'request={"index":1,"count":1,"width":595,"height":842,"targetPassword":""}'响应
成功时返回处理后的文件流。响应头包含 Content-Type 和 Content-Disposition。失败时返回统一错误 JSON。