接口描述
基于已创建的合同模板，可通过此接口再次获取模板的编辑页面链接。
【注意事项】
- 只能编辑【获取制作合同模板页面】接口制作的模板，不支持SaaS官网生成的模板。
- 沙箱环境和正式环境不互通，需要分别获取不同的页面链接进行编辑。
接口地址&请求方法
接口地址：https://{host}/v3/doc-templates/{docTemplateId}/doc-template-edit-url
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
docTemplateId | string | 是 | path | 文件模板ID（通过【获取制作文件模板页面链接】接口获取） |
redirectUrl | string | 否 | body | 编辑模板完成后页面重定向跳转地址（需符合 https /http 协议地址） |
hiddenOriginComponents | boolean | 否 | body | 是否隐藏原始控件，默认false true - 隐藏，false - 不隐藏 【注】目前仅对PDF模板生效 |
basicComponentsType | array | 否 | body | 要展示的基础控件类型列表（不传默认全部展示） 1 - 单行文本，2 - 数字，3 - 日期，5 - 骑缝签署区，6 - 普通签章区，8 - 多行文本，9 - 复选，10 - 单选，11 - 图片，14 -下拉框，15 - 勾选框，16 - 身份证，17 - 备注区域 【注】：
|
showReplaceFraft | boolean | 否 | body | 是否展示替换底稿按钮，默认值 false true - 展示替换底稿按钮 false - 不展示替换底稿按钮 【注】目前仅对PDF模板生效 |
customComponentGroups | array | 否 | body | 要展示的自定义控件组ID列表 自定义控件组请使用接口：【创建控件组】 【注】目前仅对PDF模板生效 |
customComponents | array | 否 | body | 要展示的自定义控件ID列表 自定义控件请使用接口：【创建自定义业务控件】 【注】目前仅对PDF模板生效 |
signerRoles | list | 否 | body | 签署方角色标识，只对签署区控件生效（可以自定义命名，如：甲方、乙方） 补充说明：
|
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | |
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖 message 匹配，因为 message 可能会调整。 | |
data（点击“+”展开详情） | object | 否 | 业务数据 | |
docTemplateEditUrl | string | 否 | 编辑文件模板的页面短链接（有效期24小时） | |
docTemplateEditLongUrl | string | 否 | 编辑文件模板的页面长链接（有效期24小时） | |
请求示例
POST https://openapi.esign.cn/v3/doc-templates/b7018f7e130***978925f2/doc-template-edit-url
{
"redirectUrl":"https://www.xxx.com/"
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"docTemplateEditUrl": "https://smlt.esign.cn/BdZ***",
"docTemplateEditLongUrl": "https://smlfront.esign.cn:8880/template/common/set/openApi?docTemplateId=2b0853****8ec6d7aac9708d&appId=74388****&encryption=qAJmscCZIO1Q4LGZyL4gKopy495WrZlSKNku7Bx7z9Z0pp5hKIaNgizK4Vlt1eNJg8zDXh5***Q%3D%3D&scene=api&redirectUrl=https://esign.cn"
}
}
我要纠错