Центр разработчиков

Заполните шаблон для создания файла

POST /esignglobal/v1/templates/createFileByTemplate

Описание интерфейса

На основе номера шаблона договораtemplateIdи элементов управления в шаблоне для заполнения пользовательского контента, в конечном итоге асинхронно генерируется PDF-файл.

Перед вызовом убедитесь, что шаблон находится в активном состоянии

Параметры запроса

Название параметра

Тип

Обязательно ли

Описание

templateId

string

true

ID шаблона договора

fileName

string

false

Имя сгенерированного файла

Примечание: Имя файла не должно содержать следующие 9 специальных символов: / \ : * " < > | ?и все эмодзи

fields

array

false

Информация о списке элементов управления в шаблоне (передайте значение либо ID элемента управления, либо ключа элемента управления, выбрав одно из двух)

 

fieldId

string

false

ID элемента управления (автоматически генерируется системой eSignGlobal при настройке шаблона договора)

 

fieldKey

string

false

Ключ элемента управления (пользовательский при настройке шаблона контракта)

 

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

Идентификатор задачи синтеза файла

Пример ответа

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

Описание примера заполнения элемента управления

Тип элемента управления

Пример значения заполнения элемента управления

Подробное описание

Однострочный текст

"Конкретный текст XXXXX"

Конкретный текст для заполнения

Многострочный текст

"Многострочный текст\nМногострочный текст"

Конкретный текст для заполнения,\n для переноса строки

Число

"12345"

Поддерживаются целые и дробные числа

Дата

"2025-01-01"

Формат по умолчанию: гггг-ММ-дд

Поддерживаются указанные форматы:

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 - это количество строк таблицы, добавленных при создании динамической таблицы. column1 в row - это значение ключа ячейки в текущей строке в столбце column1, column2 - это значение ключа ячейки в столбце column2.

Электронная почта

"123456@XX.com"

Адрес электронной почты

Описание интерфейса
Параметры запроса
Пример запроса
Параметры ответа
Пример ответа
Описание примера заполнения элемента управления