使用合同模板制作页面制作PDF模板及填充

本文目录导航指引

锚点跳转定位可能存在轻微页面滚动偏差，跳转后请上下滚动页面查看。

场景说明

如何制作及填充PDF模板

API列表

控件填充示例说明

场景说明

如何制作及填充PDF模板

步骤1：上传本地文件并转成PDF格式

开发者参考【上传本地文件】将本地文件上传到e签宝服务端，此接口需要生成PDF格式文件，非PDF格式文件上传，接口中 convertToPDF 参数值设置成 true，如下图：

注意：如果上传的文件本身就是PDF格式文件则不需要转换，convertToPDF 需设置为false。

步骤2：查看文件上传详情

开发者使用【查询文件上传状态】接口根据文件状态 fileStatus 判断文件上传或转换结果，也可以通过文件下载地址 fileDownloadUrl 查看上传后的文件样式内容等是否有问题。

步骤3：获取制作合同模板页面链接

开发者使用【获取制作合同模板页面】接口获取PDF模板的制作页面链接，通过此页面链接可以向模板中添加相关控件，以便后续接口向PDF模板中填充内容使用。接口中的 fileId 参数值请填写步骤1中获取到的 fileId 值。如下图：

注意：该接口返回的创建模板页面链接的有效期是24小时，若之后需再次编辑PDF模板中的控件时，可使用已保存的模板ID：docTemplateId 调用【获取编辑合同模板页面】接口获取编辑文件模板页面链接后进行相关编辑修改操作。

步骤4：制作含填充控件的PDF模板

访问【获取制作合同模板页面】接口返回的创建文件模板页面链接（docTemplateCreateUrl参数值），并在页面中拖动控件来制作模板。见如下图：

步骤5：获取PDF模板中控件详情

开发者使用【查询合同模板中控件详情】接口可获取 PDF模板中的控件ID（e签宝自动生成）或控件Key（开发者自定义）及控件类型等参数，以便后续向PDF模板中填充内容使用。如下图：

控件类型与填充示例详见文中：控件填充示例说明

步骤6：填充数据将模板生成最终文件

开发者使用【填充模板生成文件】接口 或者【获取填写合同模板页面】接口，传入PDF模板中的控件ID或控件Key以及填充的数据即可填充模板生成文件。如下图：

填充后打开步骤6返回的文件下载地址 fileDownloadUrl 查看效果：

开发者也可以通过步骤2的【查询文件上传状态】接口随时查看下载填充后的文件（签署前）。

API列表

控件填充示例说明