模板详情

接口说明

模板在签签企业端维护。本接口只读，返回指定模板的签署方与控件信息。详情不返回字体与坐标，盖章位置以模板配置为准。

请求地址：/open/v1/templates/{templateId}

请求方式：GET

在线调试

请求参数

每个请求须携带请求头 X-Api-Key。

参数名称	数据类型	必须	说明
templateId	string	是	模板 ID，路径参数

响应参数

参数名称	数据类型	必须	说明
code	number	是	0 表示成功
message	string	是	说明
data	object	是	业务数据
templateId	string	是	模板 ID
templateName	string	是	模板名称
initiatorFields	array	是	创建合同时由接入方填写的控件
fieldId	string	是	控件 ID，创建时作为 fields 的键
fieldName	string	是	控件名称
required	boolean	是	是否必填
signers	array	是	模板签署方
templateSignatoryId	string	是	模板签署方 ID
name	string	是	签署方角色名称
type	string	是	person、company，或空字符串表示创建时再指定
needSeal	boolean	是	默认是否须盖章，创建时可以覆盖
fields	array	是	该签署方的控件
fieldId	string	是	控件 ID
fieldName	string	是	控件名称
fillBy	string	是	signer 表示由签署方打开链接后填写

响应示例

{
  "code": 0,
  "message": "ok",
  "data": {
    "templateId": "1987000000000000001",
    "templateName": "劳动合同",
    "initiatorFields": [
      {
        "fieldId": "1987000000000001001",
        "fieldName": "岗位名称",
        "required": true
      }
    ],
    "signers": [
      {
        "templateSignatoryId": "1987000000000002001",
        "name": "甲方",
        "type": "company",
        "needSeal": true,
        "fields": []
      },
      {
        "templateSignatoryId": "1987000000000002002",
        "name": "乙方",
        "type": "person",
        "needSeal": true,
        "fields": [
          {
            "fieldId": "1987000000000001002",
            "fieldName": "住址",
            "fillBy": "signer"
          }
        ]
      }
    ]
  }
}

创建合同时：把 initiatorFields 写成请求体顶层对象 fields，例如 "fields": { "1987000000000001001": "产品经理" }；signers[].fields（fillBy=signer）不要放进 fields。