PDF 生成 API

❖ 功能说明

通过 HTML 内容或 HTML 模板生成 PDF 文件。

❖ 调用方式

同步请求 ✓

接口完成后直接返回结果文件，适用于小文件和需要即时反馈的场景。

异步请求

先返回任务受理结果，再通过 taskId 查询状态并下载结果，适用于大文件及批量任务。

▎调用流程

1上传文件

2调用同步接口

3获取结果文件

HTML 转 PDF

POSThttp://localhost:8080/api/v1/process/pdf/generation/html-to-pdf

❖ 请求参数 (Parameters)

x-api-key*

在 Header 中发送的 x-api-key 认证凭证，请登录 Dashboard 的 API 管理页面查看当前部署的 API Access Key。

Body Parameters multipart/form-data

htmlFileFile

选择文件未选择文件

HTML 文件；可与 request.html 或 request.htmlUrl 三选一。

requeststring

PDF 功能参数 JSON 字符串。详情请参阅 HTML 转 PDF 请求参数。

🔗请求示例 (Request)

curl --request POST \
  --url http://localhost:8080/api/v1/process/pdf/generation/html-to-pdf \
  --header 'x-api-key: YOUR API-KEY' \
  --form htmlFile=@sample.pdf

✓响应示例 (Response)

200 OK

处理成功，返回结果文件流。

模板转 PDF

POSThttp://localhost:8080/api/v1/process/pdf/generation/template-to-pdf

❖ 请求参数 (Parameters)

x-api-key*

在 Header 中发送的 x-api-key 认证凭证，请登录 Dashboard 的 API 管理页面查看当前部署的 API Access Key。

Body Parameters multipart/form-data

templateFileFile

选择文件未选择文件

HTML 模板文件；可与 request.template 二选一。

dataFileFile

选择文件未选择文件

JSON 数据文件；可与 request.data 二选一。

requeststring

PDF 功能参数 JSON 字符串。详情请参阅 模板转 PDF 请求参数。

🔗请求示例 (Request)

curl --request POST \
  --url http://localhost:8080/api/v1/process/pdf/generation/template-to-pdf \
  --header 'x-api-key: YOUR API-KEY' \
  --form templateFile=@sample.pdf

✓响应示例 (Response)

200 OK

处理成功，返回结果文件流。