获取预览合同模板页面

更新时间：2024-12-02 11:32:24

接口描述

开发者或用户通过可视化的合同模板页面来预览已经在模板里添加的各类控件（当操作者想要查看模板控件，又不想编辑改动时使用）。

【注意事项】

只能预览【获取制作合同模板页面】接口制作的模板，不支持SaaS官网生成的模板。
沙箱环境和正式环境不互通，需要分别获取不同的页面链接进行预览。

接口地址&请求方法

点击下述蓝色字体{host}可跳转至API请求域名说明文档

接口地址：https://{host}/v3/doc-templates/doc-template-preview-url

请求方法：POST

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

参数名称	参数类型	必选	参数位置	参数说明
docTemplateId	string	是	body	合同模板ID

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message 匹配，因为 message 可能会调整。
data（点击“+”展开详情）		object	否	业务数据
	docTemplatePreviewUrl	string	否	预览文件模板页面链接，有效期30分钟，过期可以重新获取

请求示例

{
  "docTemplateId": "9036ca4d1******c6095e993"
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "docTemplateId": "请忽略此字段",
        "docTemplatePreviewUrl": "https://smlfront.esign.cn:8880/template/common/preview/openApi?docTemplateId=a6b48e8****5bc69b3b7cce6&appId=7438***54&encryption=sTjwMIhpaGiWJ%2B2WvaMoMBN313tCSGUFsfKtapQfaphOck6dUquRI3U0o5QZUUQpQUoIzrS/0BGSw%3D%3D&scene=api"
    }
}

错误码

点击查看错误码