接口描述
开发者或用户通过可视化的制作合同模板页面（免登录）来添加各类控件，后续可通过【填写模板生成文件】或【获取填写合同模板页面】接口生成最终的文件。
【注意事项】
1、接口制作的合同模板是无法同步到e签宝SaaS官网的，且沙箱环境和正式环境不互通，需要分别制作。
2、合同模板分为 PDF和 HTML两种类型的模板，通过接口入参 docTemplateType 来进行区分。
- 模板中的无表格或表格属于固定行填充时，请选择 PDF 模板类型。
- 模板中的表格需要动态增加行并填充内容时，请选择 HTML模板类型。
接口地址&请求方法
点击下述蓝色字体{host}可跳转至API请求域名说明文档
接口地址：https://{host}/v3/doc-templates/doc-template-create-url
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
docTemplateName | string | 是 | body | 模板名称（可自定义模板名称） |
docTemplateType | int32 | 否 | body | 模板类型，默认值为 0 0 - PDF模板 1 - HTML模板（适用动态增加表格行并填充内容场景，仅限e签宝高级版或生态伙伴版本方可使用HTML模板类型） |
fileId | string | 是 | body | 底稿文件ID（原始文件的编号）
|
redirectUrl | string | 否 | body | 制作模板完成后页面重定向跳转地址（需符合 https /http 协议地址） |
hiddenOriginComponents | boolean | 否 | body | 是否隐藏原始控件，默认false true - 隐藏，false - 不隐藏 【注】目前仅对PDF模板生效 |
basicComponentsType | list | 否 | body | 要展示的基础控件类型列表（不传默认全部展示） 1 - 单行文本，2 - 数字，3 - 日期，5 - 骑缝签署区，6 - 普通签章区，8 - 多行文本，9 - 复选，10 - 单选，11 - 图片，14 -下拉框，15 - 勾选框，16 - 身份证，17 - 备注区域 【注】：
|
showReplaceFraft | boolean | 否 | body | 是否展示替换底稿按钮，默认值 false true - 展示替换底稿按钮 false - 不展示替换底稿按钮 【注】目前仅对PDF模板生效 |
customComponentGroups | list | 否 | body | 要展示的自定义控件组ID列表 自定义控件组请使用接口：【创建控件组】 【注】目前仅对PDF模板生效 |
customComponents | list | 否 | body | 要展示的自定义控件ID列表 自定义控件请使用接口：【创建自定义业务控件】 【注】目前仅对PDF模板生效 |
signerRoles | list | 否 | body | 签署方角色标识，只对签署区控件生效（可以自定义命名，如：甲方、乙方） 补充说明：
|
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖 message 匹配，因为 message 可能会调整。 | |
data（点击“+”展开详情） | object | 否 | 业务数据 | |
docTemplateId | string | 否 | 合同模板ID（建议开发者保管，当制作合同模板的链接过期失效后，可用于再次获取该模板的编辑链接，以及之后填充控件内容） | |
docTemplateCreateUrl | string | 否 | 制作合同模板的页面短链接（有效期24小时） | |
docTemplateCreateLongUrl | string | 否 | 制作合同模板的页面长链接（有效期24小时） | |
请求示例
{
"docTemplateName":"某公司的劳动合同模板",
"docTemplateType":0,
"fileId":"0e99de7ce***9db2cd69",
"redirectUrl":"https://www.xxx.cn/",
"signerRoles": [
"甲方",
"乙方"
]
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"docTemplateId": "9036ca4d1******c6095e993",
"docTemplateCreateUrl": "https://smlt.esign.cn/m***ILc",
"docTemplateCreateLongUrl": "https://smlfront.esign.cn:8880/template/common/set/openApi?docTemplateId=9036c*****36024c6095e993&appId=4438864954&encryption=I7oRzgRCPI0iEpIDVktPAZ5spOU0hiD0ECwhHJP3rw1wmmQpRAgIPwFzWHbn15Hv&scene=api&redirectUrl=https://esign.cn"
}
}
我要纠错