PDF 生成模板编辑器
开源可视化 PDF 生成引擎，支持自定义模板，并提供面向开发者的 API，灵活构建文档生成流程。
PDF 加密 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/encrypt |
| 请求类型 | multipart/form-data |
| 成功响应 | 结果文件流 |
请求参数
| 参数名 | 类型 | 说明 | 是否必填 |
|---|---|---|---|
file | File | 源 PDF 文件。 | 是 |
request | String | JSON 字符串，包含下方 PDF SDK 参数。若省略 request，其他非文件 form-data 字段会作为 request 对象转发。 | 否 |
Request 参数
以下字段放入 request JSON 字符串中。
| 参数名 | 类型 | 作用 |
|---|---|---|
userPassword | String | 打开加密 PDF 所需的用户密码。 |
ownerPassword | String | 用于管理权限的所有者密码。 |
permissions | Object | 转发给 SDK 的权限对象。 |
allowPrint | Boolean | 可选快捷字段，会映射到 permissions.allowPrint。 |
allowCopy | Boolean | 可选快捷字段，会映射到 permissions.allowCopy。 |
allowDocumentChanges | Boolean | 可选快捷字段，会映射到 permissions.allowDocumentChanges。 |
allowDocumentAssembly | Boolean | 可选快捷字段，会映射到 permissions.allowDocumentAssembly。 |
allowCommenting | Boolean | 可选快捷字段，会映射到 permissions.allowCommenting。 |
allowFormFieldEntry | Boolean | 可选快捷字段，会映射到 permissions.allowFormFieldEntry。 |
outputFileName | String | 可选输出文件名。传入后会作为首选下载文件名。 |
请求示例
bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/encrypt" \
-H "x-api-key: your_api_key_here" \
-F "[email protected]" \
-F 'request={"userPassword":"user-pass","ownerPassword":"owner-pass","permissions":"","allowPrint":"","allowCopy":""}'响应
成功时返回处理后的文件流。响应头包含 Content-Type 和 Content-Disposition。失败时，ComPDF Self-hosted 返回接口错误码中定义的统一错误响应，其中包含 type、code、errorCode、message 和 traceId。