Central do desenvolvedor

Preencher o modelo para gerar o ficheiro

POST /esignglobal/v1/templates/createFileByTemplate

Descrição da Interface

Baseado no número do modelo de contratotemplateIde nos controlos do modelo para preencher o conteúdo personalizado, gerando finalmente um ficheiro PDF de forma assíncrona.

Certifique-se de que o estado do modelo está ativado antes de chamar

Parâmetros de Pedido

Nome do Parâmetro

Tipo

Obrigatório

Descrição

templateId

string

true

ID do Modelo de Contrato

fileName

string

false

Nome do ficheiro gerado

Nota: O nome do ficheiro não pode conter os seguintes 9 caracteres especiais: / \ : * " < > | ?e todos os emojis

fields

array

false

Informações da lista de controlos no modelo (o ID do controlo e a Chave do controlo são opcionais)

 

fieldId

string

false

ID do controlo (gerado automaticamente pelo sistema eSignGlobal ao definir o modelo de contrato)

 

fieldKey

string

false

Chave do controlo (personalizado pelo utilizador ao definir o modelo de contrato)

 

fieldValue

string

false

Valor de preenchimento do controlo
(1)Pode ser preenchido de acordo com o tipo de controlo;
(2)Ao preencher um controlo de tabela dinâmica, o valor do parâmetro insertRow deve ser transmitido como verdadeiro se for necessário adicionar uma nova linha de dados

callBackUrl

string

false

Endereço de retorno de chamada (comprimento máximo de 500), deve ser um endereço https válido

Exemplo de pedido

{
    "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 resposta

Nome do parâmetro

Tipo

Descrição

taskId

string

ID da tarefa de síntese de ficheiros

Exemplo de resposta

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

Descrição do exemplo de preenchimento do controlo

Tipo de controlo

Valor de exemplo de preenchimento do controlo

Instruções específicas

Texto de linha única

"Texto específico XXXXX"

Texto específico a preencher

Texto de várias linhas

"Texto de várias linhas\nTexto de várias linhas"

Texto específico a preencher,\n para inserir uma nova linha

Número

"12345"

Suporta números inteiros e decimais

Data

"2025-01-01"

O formato predefinido é aaaa-MM-dd

Suporta formatos especificados:

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd,yyyy

dd MM yyyy

Escolha única

"1"

Ordenado a partir de 0,0representa a opção 1,1representa a opção 2....

Escolha múltipla

"[0,1,2]"

Ordenado a partir de 0,0representa a opção 1,1representa a opção 2....

Assinalar

"0" 、"1"、"2"

0 - Não selecionado

1 - Selecionado ✓

2 - Marcado com X ✗ (necessário ativar a opção "Permitir marcar com X" na configuração do modelo)

Seleção suspensa

"0"

Ordenado a partir de 0,0representa a opção 1,1representa a opção 2....

Imagem

"URL"

Necessário carregar o link da imagem

Tabela dinâmica

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

row são os dados das linhas na tabela dinâmica, o número de row é o número de linhas da tabela adicionadas ao criar a tabela dinâmica. column1 em row é o valor da chave da célula na coluna column1 na linha atual, column2 é o valor da chave da célula na coluna column2.

E-mail

"123456@XX.com"

Endereço de e-mail

Descrição da Interface
Parâmetros de Pedido
Exemplo de pedido
Parâmetros de resposta
Exemplo de resposta
Descrição do exemplo de preenchimento do controlo