填寫模板生成文件

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"

郵箱地址

接口描述
請求參數
請求示例
響應參數
響應示例
控件填充示例說明