DocSpring 如何用 API 填写和生成 PDF?
DocSpring 是一个把「PDF 模板设计」和「数据填充」拆成两步的在线服务:你先在它的拖拽式编辑器里做好一份带占位字段的 PDF 模板,之后每次需要生成文件时,只需向它的 API 发一次请求、把数据以 JSON 形式 POST 过去,服务端就会把数据填进模板并返回一份成品 PDF,通常几秒内就能拿到。它适合需要批量、重复生成同类文档的场景,比如合同、发票、证书、报表;如果你只是偶尔手动填一份 PDF,用本地工具可能更省事。
核心工作流程
DocSpring 的流程可以概括为「设计一次,调用多次」:
- 设计模板:在 DocSpring 的拖拽式编辑器中创建或上传 PDF,放置文本、图片等字段,并给每个字段命名(这些名字就是后面 JSON 里的键)。
- 提交数据:向 API 发起请求,把要填入的内容以 JSON 格式 POST 过去。
- 服务端填充:DocSpring 在服务端把 JSON 数据映射到模板字段,生成最终 PDF。
- 获取结果:几秒内可下载成品 PDF,或让它自动上传到你自己的存储位置。
这个拆分的好处是:模板的版式由设计者固定,业务数据由程序提供,两边互不干扰,适合自动化流水线。
模板设计阶段
模板是整条链路的起点,字段命名直接决定了后续 API 请求怎么写。
- 使用拖拽式编辑器布局,不需要写 PDF 底层代码。
- 为每个需要动态填充的位置定义字段,并给字段起一个清晰、稳定的名字。
- 模板一旦定稿,字段名应尽量保持不变,否则调用方需要同步修改 JSON 的键。
API 调用阶段
调用阶段的核心动作是「POST JSON 数据」。请求里携带的是与模板字段对应的键值对,服务端据此完成填充。
预期结果是:请求成功后得到一份填好的 PDF。由于官方描述强调「几秒内」完成,可以把它理解为接近实时的生成,而不是需要长时间排队的批处理。
自动存储到 S3
除了直接下载,DocSpring 支持把生成的 PDF 自动上传到你自己的 Amazon S3 存储桶。官方页面在功能列表中明确提到这一点,并提供了 AWS S3 的设置入口。
适用条件:你需要先拥有自己的 S3 桶并完成相应配置。如果你的下游系统本来就以 S3 为文件中枢,这个能力可以省掉「先下载再上传」的中间步骤。
它适合什么场景
| 场景特征 | 是否适合 |
|---|---|
| 同一版式、需要反复生成大量文档 | 适合 |
| 数据来自程序或系统,需要自动填充 | 适合 |
| 生成后要归档到自己的对象存储 | 适合(配合 S3) |
| 偶尔手动填一份 PDF | 不一定划算,本地工具更直接 |
使用前需要确认的点
- 字段与数据的对应关系:模板字段名和 JSON 键必须一致,这是最常见的出错来源。
- 存储配置:如果要用自动上传 S3,需要提前准备好桶和权限。
- 价格与试用:官网提供 Pricing 页面,并出现 free trial 相关信号,具体额度、限制和计费方式请以该页面为准,本文不代为推断。
如果你的目标是让「一份固定版式的 PDF」能被程序反复、自动地生成出来,DocSpring 的模板 + API 两步模式正好对应这个需求;先想清楚模板字段怎么命名,再决定数据从哪来、成品存到哪,整条链路就通了。