接口描述
基于合同模板编号： docTemplateId和模板中的控件来填充自定义的内容，最终生成一份pdf文件。
【注意事项】：使用HTML动态模板时，填充的表格行数不能超过2000行（性能限制）。
接口地址&请求方法
接口地址：https://{host}/v3/files/create-by-doc-template
请求方法：POST
请求头格式
具体请求头参数，请查看公共请求头格式。
请求参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 | |
docTemplateId | string | 是 | body | 待填充的模板ID（通过【获取制作合同模板页面】接口获取） | |
fileName | string | 是 | body | 填充后生成的文件名称（可自定义文件名称） 【注】文件名称不可含有以下9个特殊字符：/ \ : * " < > | ？以及所有emoji表情 | |
components（点击“+”展开详情） | array | 是 | body | 控件列表（控件ID和 控件Key 二选一传值） | |
componentId | string | 否 | body | 控件ID（设置合同模板时由e签宝系统自动生成） | |
componentKey | string | 否 | body | 控件Key（设置合同模板时由用户自定义） | |
componentValue | string | 否 | body | 控件填充值 补充说明： （1）可根据控件类型进行填充，点击查看填充值示例； （2）填充动态表格控件时，若需新增一行数据时 insertRow 参数值必须传 true； （3）点击查看如何填充动态表格。 | |
requiredCheck | boolean | 否 | body | 是否校验PDF模板中必填控件，默认：false false：不校验模板中必填控件（components必须传，可以传空数组）； true：校验模板中必填控件 ，必填控件不传值会报错："创建合同失败: 'XX控件名称'填充内容缺失" 。 补充说明： 该参数只针对PDF模板生效，HTML模板不生效，即：HTML模板会强制校验必填控件。 | |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | ||
code | int32 | 是 | 业务码，0表示成功，非0表示异常。 | ||
message | string | 否 | 业务信息 请根据 code 来判断错误情况，不应该依赖 message 匹配，因为 message 可能会调整。 | ||
data（点击“+”展开详情） | object | 否 | 业务数据 | ||
fileId | string | 否 | 填充后生成的文件ID | ||
fileDownloadUrl | string | 否 | 文件下载地址（有效期为60分钟，过期后可以重新调用接口获取新的下载地址）
| ||
请求示例
{
"docTemplateId":"8726f6b***03a56d",
"fileName":"某公司的交易协议签署文件",
"components":[
{
"componentId":"59af7766***36ef41b",
"componentKey":"",
"componentValue":"这里是填充的文本"
},
{
"componentId":"7315e9af**72d2dac40",
"componentKey":"",
"componentValue":"2022/01/01"
}
]
}响应示例
{
"code": 0,
"message": "成功",
"data": {
"fileId": "376977ed9***5d412b43",
"fileDownloadUrl": "https://esignoss.esign.cn/1111564182/e775bca.pdf?Expires=**&OSSAccessKeyId=**&Signature=**%3D"
}
}
我要纠错