Centre de développement

Remplir le modèle pour générer un fichier

POST /esignglobal/v1/templates/createFileByTemplate

Description de l'interface

Basé sur le numéro de modèle de contrattemplateIdet les contrôles du modèle pour remplir le contenu personnalisé, et finalement générer de manière asynchrone un fichier PDF.

Veuillez vous assurer que le statut du modèle est activé avant d'appeler

Paramètres de requête

Nom du paramètre

Type

Obligatoire

Description

templateId

string

true

ID du modèle de contrat

fileName

string

false

Nom du fichier généré

Remarque : Le nom du fichier ne doit pas contenir les 9 caractères spéciaux suivants : / \ : * " < > | ? ni aucune émoticône emoji

fields

array

false

Informations sur la liste des contrôles dans le modèle (transmettre la valeur en choisissant l'ID du contrôle ou la clé du contrôle)

 

fieldId

string

false

ID du contrôle (généré automatiquement par le système eSignGlobal lors de la configuration du modèle de contrat)

 

fieldKey

string

false

Clé du contrôle (définie par l'utilisateur lors de la configuration du modèle de contrat)

 

fieldValue

string

false

Valeur de remplissage du contrôle
(1)Peut être rempli en fonction du type de contrôle ;
(2)Lors du remplissage d'un contrôle de tableau dynamique, si une nouvelle ligne de données doit être ajoutée, la valeur du paramètre insertRow doit être true

callBackUrl

string

false

Adresse de rappel (longueur maximale de 500), doit être une adresse https valide

Exemple de requête

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

Paramètres de réponse

Nom du paramètre

Type

Description

taskId

string

ID de la tâche de synthèse de fichier

Exemple de réponse

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

Description de l'exemple de remplissage du contrôle

Type de contrôle

Exemple de valeur de remplissage du contrôle

Description détaillée

Texte sur une seule ligne

"Texte spécifique XXXXX"

Texte spécifique à remplir

Texte multiligne

"Texte multiligne\nTexte multiligne"

Texte spécifique à remplir,\n pour effectuer un saut de ligne

Nombre

"12345"

Prend en charge les nombres entiers et décimaux

Date

"2025-01-01"

Le format par défaut est aaaa-MM-jj

Formats pris en charge :

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd,yyyy

dd MM yyyy

Choix unique

"1"

Tri à partir de 0,0représente l'option 1,1représente l'option 2....

Choix multiple

"[0,1,2]"

Tri à partir de 0,0représente l'option 1,1représente l'option 2....

Cocher

"0" 、"1"、"2"

0 - Non sélectionné

1 - Sélectionné ✓

2 - Croix ✗ (doit activer l'option "Autoriser la croix" dans la configuration du modèle)

Sélection déroulante

"0"

Tri à partir de 0,0représente l'option 1,1représente l'option 2....

Image

"URL"

Nécessite de télécharger un lien d'image

Tableau dynamique

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

row est la donnée de ligne dans le tableau dynamique, le nombre de row est le nombre de lignes de tableau ajoutées lors de la création du tableau dynamique. column1 dans row est la valeur de clé de la cellule sur la colonne column1 dans la ligne actuelle, column2 est la valeur de clé de la cellule sur la colonne column2.

Email

"123456@XX.com"

Adresse e-mail

Description de l'interface
Paramètres de requête
Exemple de requête
Paramètres de réponse
Exemple de réponse
Description de l'exemple de remplissage du contrôle