填写模板生成文件

POST /esignglobal/v1/templates/createFileByTemplate

接口描述

基于合同模板编号templateId和模板中的控件来填充自定义的内容,最终异步生成一份pdf文件。

调用前请确保模板状态为启用状态

请求参数

参数名称

类型

是否必填

说明

templateId

string

true

合同模板ID

fileName

string

false

生成后的文件名称

注:文件名称不可含有以下9个特殊字符:/ \ : * " < > | ?以及所有emoji表情

fields

array

false

模板中的控件列表信息(控件ID和控件Key二选一传值)

 

fieldId

string

false

控件ID(设置合同模板时eSignGlobal系统自动生成)

 

fieldKey

string

false

控件Key(设置合同模板时用户自定义)

 

fieldValue

string

false

控件填充值
(1)可根据控件类型进行填充;
(2)填充动态表格控件时,若需新增一行数据时 insertRow 参数值必须传 true

callBackUrl

string

false

回调地址(最大长度500),需为有效的https地址

请求示例

{
    "templateId": "1866fd459647435b98f7d40b2a9bc33e",
    "fields": [
        {
        	"fieldKey": "Number",
        	"fieldValue": "120000100101.001"
        },
        {
        	"fieldKey": "Date",
        	"fieldValue": "2025-07-07"
        },
        {
        	"fieldKey": "Checkbox",
        	"fieldValue": "[0,1,2]"
        },
        {
        	"fieldKey": "Radio",
        	"fieldValue": "1"
        },
        {
        	"fieldKey": "Select",
        	"fieldValue": "0"
        },
        {
        	"fieldKey": "Email",
        	"fieldValue": "test@gmail.com"
        },
        {
        	"fieldKey": "mergeFilling",
        	"fieldValue": "eSignGlobal"
        },
        {
        	"fieldKey": "tabkey",
        	"fieldId": "537c875667f24b9782a7bb42f1dc98b2",
        	"fieldValue": "[{\"row\":{\"column1\":\"Name\"}},{\"row\":{\"column1\":\"Jack\"}},{\"insertRow\":\"true\",\"row\":{\"column1\":\"Mike\"}}]"
        },
        {
        	"fieldId": "4d25013762f042758cdd727a9d4f8029",
        	"fieldKey": "",
        	"fieldValue": "123"
        }
    ]
}

响应参数

参数名称

类型

说明

taskId

string

文件合成任务id

响应示例

{
    "code": "0",
    "data": {
        "taskId": "7e6d1125dc164fa4b2c268f8bb809dea"
    },
    "message": "success"
}

控件填充示例说明

控件类型

控件填充示例值

具体说明

单行文本

"具体文字XXXXX"

填充的具体文字

多行文本

"多行文字\n多行文字"

填充的具体文字,\n 进行换行

数字

"12345"

支持整数和小数

日期

"2025-01-01"

默认格式为yyyy-MM-dd

支持指定格式:

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd,yyyy

dd MM yyyy

单选

"1"

从0开始排序,0代表选项1,1代表选项2....

多选

"[0,1,2]"

从0开始排序,0代表选项1,1代表选项2....

勾选

"0" 、"1"、"2"

0 - 未选中

1 - 选中 ✓

2 - 打叉 ✗(需在模板配置中开启"允许打叉"选项)

下拉选择

"0"

从0开始排序,0代表选项1,1代表选项2....

图片

"URL"

需要上传图片链接

动态表格

[{\"row\":{\"column1\":\"具体内容\"}},{\"row\":{\"column1\":\"具体内容\"}},{\"insertRow\":\"true\",\"row\":{\"column1\":\"Mike\"}}]

row是动态表格中的行数据,row的个数就是动态表格制作时所添加的表格行数。row中的column1为当前行中列为column1上的单元格Key值,column2是列为column2的单元格Key值。

邮箱

"123456@XX.com"

邮箱地址

接口描述
请求参数
请求示例
响应参数
响应示例
控件填充示例说明