Centro de desarrolladores

Llenar la plantilla para generar el archivo

POST /esignglobal/v1/templates/createFileByTemplate

Descripción de la interfaz

Basado en el número de plantilla de contratotemplateIdy los controles en la plantilla para completar el contenido personalizado, y finalmente generar un archivo PDF de forma asíncrona.

Asegúrese de que el estado de la plantilla sea habilitado antes de llamar

Parámetros de solicitud

Nombre del parámetro

Tipo

Obligatorio

Descripción

templateId

string

true

ID de la plantilla de contrato

fileName

string

false

Nombre del archivo generado

Nota: El nombre del archivo no puede contener los siguientes 9 caracteres especiales: / \ : * " < > | ? ni ningún emoji

fields

array

false

Lista de información de los controles en la plantilla (el ID del control y la clave del control se transmiten como una de las dos opciones)

 

fieldId

string

false

ID del control (generado automáticamente por el sistema eSignGlobal al configurar la plantilla de contrato)

 

fieldKey

string

false

Clave del control (definida por el usuario al configurar la plantilla del contrato)

 

fieldValue

string

false

Valor de relleno del control
(1)Se puede rellenar según el tipo de control;
(2)Al rellenar un control de tabla dinámica, si es necesario agregar una nueva fila de datos, el valor del parámetro insertRow debe ser verdadero

callBackUrl

string

false

Dirección de callback (longitud máxima de 500), debe ser una dirección https válida

Ejemplo de solicitud

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

Parámetros de respuesta

Nombre del parámetro

Tipo

Descripción

taskId

string

Id. de la tarea de síntesis de archivos

Ejemplo de respuesta

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

Descripción del ejemplo de relleno del control

Tipo de control

Valor de ejemplo para el relleno del control

Descripción específica

Texto de una sola línea

"Texto específico XXXXX"

Texto específico para rellenar

Texto de varias líneas

"Texto de varias líneas\nTexto de varias líneas"

Texto específico para rellenar,\n para saltar de línea

Número

"12345"

Admite enteros y decimales

Fecha

"2025-01-01"

El formato predeterminado es yyyy-MM-dd

Admite el formato especificado:

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd,yyyy

dd MM yyyy

Opción única

"1"

Ordenado desde 0,0representa la opción 1,1representa la opción 2....

Opción múltiple

"[0,1,2]"

Ordenado desde 0,0representa la opción 1,1representa la opción 2....

Marcar

"0" 、"1"、"2"

0 - No seleccionado

1 - Seleccionado ✓

2 - Marcado con una cruz ✗ (necesita habilitar la opción "Permitir marcar con una cruz" en la configuración de la plantilla)

Selección desplegable

"0"

Ordenar desde 0,0representa la opción 1,1representa la opción 2....

Imagen

"URL"

Necesita subir el enlace de la imagen

Tabla dinámica

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

row son los datos de la fila en la tabla dinámica, el número de row es el número de filas de la tabla que se agregaron al crear la tabla dinámica. column1 en row es el valor de la clave de la celda en la columna column1 de la fila actual, column2 es el valor de la clave de la celda en la columna column2.

Correo electrónico

"123456@XX.com"

Dirección de correo electrónico

Descripción de la interfaz
Parámetros de solicitud
Ejemplo de solicitud
Parámetros de respuesta
Ejemplo de respuesta
Descripción del ejemplo de relleno del control