自2023年8月14日起，不再推荐借用e签宝官网制作文件模板方式（由于e签宝官网的模板属于流程模板，不支持与接口的文件模板结合），建议使用接口获取模板制作链接，点击跳转接口制作模板方案：【使用合同模板制作页面制作PDF模板及填充】
如一定需要使用e签宝官网模板功能，建议接入【流程模板服务】
以下流程不推荐：
本文目录导航指引
锚点跳转定位可能存在轻微页面滚动偏差，跳转后请上下滚动页面查看。
场景说明
当合同中有不固定的内容需要填充，需要提前制作合同模板并进行填充。
当需要借助e签宝SaaS官网来制作和维护PDF模板，并通过接口来填充不固定的内容时，可参考本流程。
制作PDF模板：希望可以直接登录e签宝SaaS官网来制作和维护PDF模板。
填写PDF模板：希望可以通过系统后台接口传参方式直接填写PDF模板。
对接场景符合以上两点时，开发者可参考本文进行相关接口对接。
如何制作及填充PDF模板
1.通过e签宝SaaS官网制作及维护PDF模板
步骤1：登录e签宝SaaS官网并进入模板管理页面
沙箱模拟环境地址：https://smlfront.esign.cn:8880/templates（首次登录需用短信验证码方式）
正式生产环境地址：https://web.esign.cn/templates（首次登录需用短信验证码方式）
【注意事项】
沙箱模拟环境的官网和正式生产环境的官网数据不互通，若想要把沙箱模拟环境制作的模板复制迁移到正式生产环境直接使用，请参考《文件模板跨环境复制迁移操作手册》。
步骤2：配置模板基础信息
步骤3：制作模板控件
2.通过接口填写PDF模板
步骤4：获取模板Id和控件key
注意：
（1）进入到模板制作页面可随时复制模板唯一标识：模板Id（也可在上一步制作模板时直接获取）。
（2）模板中控件的key值建议直接通过【查询合同模板中控件详情】接口统一查询，否则就要在模板制作页面逐个复制控件编码：控件的key值（也可在上一步制作模板时直接获取）。
注意：新版本模板ID在右侧（如上图），老版本模板ID在左上角的省略号里。以下为老版本的页面：
步骤5：获取模板中控件详情
开发者使用【查询合同模板中控件详情】接口可获取控件key（开发者自定义）或者控件Id及控件类型等参数，以便后续【填充模板生成文件】接口向PDF模板中填充内容使用。也可查询记录签署区坐标位置，方便后续发起签署时指定。如下图：
步骤6：填充数据将模板生成最终文件
开发者使用【填充模板生成文件】接口，传入PDF模板中的控件key或控件Id（控件key和控件Id二选一）以及填充的数据即可填充模板生成文件。如下图：
填充后打开步骤6返回的文件下载地址 fileDownloadUrl 查看效果：
开发者也可以通过【查询PDF模板填写后文件】接口随时查看下载填充后的文件（签署前）。
API列表
API接口（点击直接跳转相关API文档） | API描述 | 是否必需 |
此接口可以通过模板ID来获取模板中设置的所有控件信息，获取模板控件ID/控件Key等，用于后续填充具体的内容。 | 建议 | |
基于模板ID和模板中的控件来填充自定义的内容，最终生成一份待签署的PDF文件。 | 必需 | |
此接口可以下载填充后的文件，检查填充内容是否正确。 | 按需 | |
此接口可以查询appId对应的主体在e签宝官网制作的全部模板列表。 | 按需 |
控件填充示例说明
使用条件：使用e签宝在线模板制作方式制作的控件（包含本文中介绍的方式以及e签宝官网制作的模板）。
控件类型 | 控件描述 | 控件填充示例值 | 具体说明 |
1 | 单行文本 | "具体文字XXXXX" | 填充的具体文字 |
2 | 数字 | "12345" | 支持整数和小数 |
3 | 日期 | "2022-04-20" | 日期支持yyyy/MM/dd，yyyy-MM-dd，yyyy年MM月dd日三种格式 |
8 | 多行文本 | "多行文字\n多行文字" | 填充的具体文字，\n进行换行 |
9 | 复选 | "[0,1,2]" | 从0开始排序，0代表选项1，1代表选项2.... |
10 | 单选 | "1" | 从0开始排序，0代表选项1，1代表选项2.... |
11 | 图片 | "ec71ce001a164066bfe11a66a9a001ca" | 需要将图片作为文件上传，获取到文件fileId作为value值传入 |
14 | 下拉框 | "0" | 从0开始排序，0代表选项1，1代表选项2.... |
15 | 勾选框 | "true"或者"false" | true代表选中，false代表不选 |
16 | 身份证号 | "11100019900101000X" | 18位身份证格式 |
19 | 手机号 | "13000000000" | 11位手机号码格式 |
我要纠错