开发者中心

Compila il modello per generare il file

POST /esignglobal/v1/templates/createFileByTemplate

Descrizione dell'interfaccia

Basato sul numero del modello di contrattotemplateIde sui controlli nel modello per riempire il contenuto personalizzato, generando infine in modo asincrono un file PDF.

Assicurarsi che lo stato del modello sia abilitato prima di chiamare

Parametri di richiesta

Nome parametro

Tipo

Obbligatorio

Descrizione

templateId

string

true

ID modello contratto

fileName

string

false

Nome del file generato

Nota: il nome del file non può contenere i seguenti 9 caratteri speciali: / \ : * " < > | ?e tutte le emoji

fields

array

false

Informazioni sull'elenco dei controlli nel modello (trasmettere il valore scegliendo tra ID controllo e Chiave controllo)

 

fieldId

string

false

ID controllo (generato automaticamente dal sistema eSignGlobal durante l'impostazione del modello di contratto)

 

fieldKey

string

false

Chiave del controllo (personalizzata dall'utente quando imposta il modello di contratto)

 

fieldValue

string

false

Valore di riempimento del controllo
(1)Può essere riempito in base al tipo di controllo;
(2)Quando si riempie un controllo tabella dinamica, se è necessario aggiungere una nuova riga di dati, il valore del parametro insertRow deve essere true

callBackUrl

string

false

Indirizzo di callback (lunghezza massima 500), deve essere un indirizzo https valido

Esempio di richiesta

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

Parametri di risposta

Nome parametro

Tipo

Descrizione

taskId

string

ID attività di sintesi file

Esempio di risposta

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

Istruzioni per l'esempio di riempimento del controllo

Tipo di controllo

Valore di esempio per il riempimento del controllo

Istruzioni specifiche

Testo a riga singola

"Testo specifico XXXXX"

Testo specifico da inserire

Testo multilinea

"Testo multilinea\nTesto multilinea"

Testo specifico da inserire,\n per andare a capo

Numero

"12345"

Supporta numeri interi e decimali

Data

"2025-01-01"

Il formato predefinito è aaaa-MM-gg

Supporta il formato specificato:

yyyy anno MM mese dd giorno

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd, yyyy

dd MM yyyy

Scelta singola

"1"

Ordinamento a partire da 0,0rappresenta l'opzione 1,1rappresenta l'opzione 2....

Scelta multipla

"[0,1,2]"

Ordinamento a partire da 0,0rappresenta l'opzione 1,1rappresenta l'opzione 2....

Spuntato

"0" 、"1"、"2"

0 - Non selezionato

1 - Selezionato ✓

2 - Barrato ✗ (deve essere abilitata l'opzione "Permetti di barrare" nella configurazione del modello)

Selezione a tendina

"0"

Ordinamento a partire da 0,0rappresenta l'opzione 1,1rappresenta l'opzione 2....

Immagine

"URL"

È necessario caricare il link dell'immagine

Tabella dinamica

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

row sono i dati delle righe nella tabella dinamica, il numero di row è il numero di righe della tabella aggiunte durante la creazione della tabella dinamica. column1 in row è il valore della chiave della cella nella colonna column1 nella riga corrente, column2 è il valore della chiave della cella nella colonna column2.

Email

"123456@XX.com"

Indirizzo email

Descrizione dell'interfaccia
Parametri di richiesta
Esempio di richiesta
Parametri di risposta
Esempio di risposta
Istruzioni per l'esempio di riempimento del controllo