Trung tâm nhà phát triển

Điền vào mẫu để tạo tệp

POST /esignglobal/v1/templates/createFileByTemplate

Mô tả giao diện

Dựa trên số hiệu mẫu hợp đồngtemplateIdvà các điều khiển trong mẫu để điền nội dung tùy chỉnh, cuối cùng tạo một tệp pdf không đồng bộ.

Vui lòng đảm bảo trạng thái mẫu là đã bật trước khi gọi

Tham số yêu cầu

Tên tham số

Loại

Bắt buộc

Mô tả

templateId

string

true

ID mẫu hợp đồng

fileName

string

false

Tên tệp sau khi tạo

Lưu ý: Tên tệp không được chứa 9 ký tự đặc biệt sau: / \ : * " < > | ?và tất cả các biểu tượng cảm xúc emoji

fields

array

false

Thông tin danh sách điều khiển trong mẫu (chọn một trong hai giá trị ID điều khiển và Khóa điều khiển để truyền)

 

fieldId

string

false

ID điều khiển (hệ thống eSignGlobal tự động tạo khi thiết lập mẫu hợp đồng)

 

fieldKey

string

false

Khóa điều khiển (người dùng tự xác định khi cài đặt mẫu hợp đồng)

 

fieldValue

string

false

Giá trị điền vào điều khiển
(1)Có thể điền theo loại điều khiển;
(2)Khi điền vào điều khiển bảng động, nếu cần thêm một hàng dữ liệu, giá trị tham số insertRow phải được truyền là true

callBackUrl

string

false

Địa chỉ gọi lại (chiều dài tối đa 500), phải là địa chỉ https hợp lệ

Ví dụ yêu cầu

{
    "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"
        }
    ]
}

Tham số phản hồi

Tên tham số

Loại

Mô tả

taskId

string

ID nhiệm vụ tổng hợp tệp

Ví dụ phản hồi

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

Mô tả ví dụ về điền điều khiển

Loại điều khiển

Giá trị mẫu điền vào điều khiển

Giải thích cụ thể

Văn bản một dòng

"Văn bản cụ thể XXXXX"

Văn bản cụ thể để điền

Văn bản nhiều dòng

"Văn bản nhiều dòng\nVăn bản nhiều dòng"

Văn bản cụ thể để điền,\n xuống dòng

Số

"12345"

Hỗ trợ số nguyên và số thập phân

Ngày

"2025-01-01"

Định dạng mặc định là yyyy-MM-dd

Hỗ trợ định dạng được chỉ định:

yyyy năm MM tháng dd ngày

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd,yyyy

dd MM yyyy

Chọn một

"1"

Sắp xếp bắt đầu từ 0,0Đại diện cho tùy chọn 1,1Đại diện cho tùy chọn 2....

Chọn nhiều

"[0,1,2]"

Sắp xếp bắt đầu từ 0,0Đại diện cho tùy chọn 1,1Đại diện cho tùy chọn 2....

Đánh dấu chọn

"0" 、"1"、"2"

0 - Chưa chọn

1 - Đã chọn ✓

2 - Đánh dấu X ✗ (cần bật tùy chọn "Cho phép đánh dấu X" trong cấu hình mẫu)

Chọn thả xuống

"0"

Sắp xếp bắt đầu từ 0,0đại diện cho tùy chọn 1,1đại diện cho tùy chọn 2....

Hình ảnh

"URL"

Cần tải lên liên kết hình ảnh

Bảng động

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

row là dữ liệu hàng trong bảng động, số lượng row là số hàng bảng được thêm vào khi tạo bảng động. column1 trong row là giá trị Key của ô ở cột column1 trong hàng hiện tại, column2 là giá trị Key của ô ở cột column2.

Email

"123456@XX.com"

Địa chỉ email

Mô tả giao diện
Tham số yêu cầu
Ví dụ yêu cầu
Tham số phản hồi
Ví dụ phản hồi
Mô tả ví dụ về điền điều khiển