Vorlage ausfüllen, um Datei zu generieren

POST /esignglobal/v1/templates/createFileByTemplate

Schnittstellenbeschreibung

Basierend auf der VertragsnummertemplateIdund den Steuerelementen in der Vorlage, um benutzerdefinierte Inhalte einzufügen und schließlich asynchron eine PDF-Datei zu erstellen.

Bitte stellen Sie vor dem Aufruf sicher, dass der Vorlagenstatus aktiviert ist

Anfrageparameter

Parametername		Typ	Ist erforderlich	Beschreibung
templateId		string	true	Vertragsvorlagen-ID
fileName		string	false	Name der generierten Datei Hinweis: Der Dateiname darf nicht die folgenden 9 Sonderzeichen enthalten: / \ : * " < > \| ？ sowie alle Emoji-Smileys
fields		array	false	Liste der Steuerelementinformationen in der Vorlage (Steuerelement-ID und Steuerelement-Key können alternativ übergeben werden)
	fieldId	string	false	Steuerelement-ID (wird automatisch vom eSignGlobal-System beim Festlegen der Vertragsvorlage generiert)
	fieldKey	string	false	Steuerelement-Key (benutzerdefiniert beim Festlegen der Vertragsvorlage)
	fieldValue	string	false	Steuerelement-Füllwert （1）Kann je nach Steuerelementtyp gefüllt werden; （2）Beim Füllen von dynamischen Tabellensteuerelementen muss der Parameterwert insertRow als "true" übergeben werden, wenn eine neue Datenzeile hinzugefügt werden soll
callBackUrl		string	false	Callback-Adresse (maximale Länge 500), muss eine gültige HTTPS-Adresse sein

Beispielanfrage

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

Antwortparameter

Parametername	Typ	Beschreibung
taskId	string	Datei-Synthese-Aufgaben-ID

Beispielantwort

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

Erläuterung zum Beispiel für das Füllen von Steuerelementen

Steuerungselementtyp	Beispielwerte für die Steuerungselementfüllung	Detaillierte Beschreibung
Einzeiliger Text	"Konkreter Text XXXXX"	Der auszufüllende konkrete Text
Mehrzeiliger Text	"Mehrzeiliger Text\nMehrzeiliger Text"	Der auszufüllende konkrete Text,`\n` für einen Zeilenumbruch
Zahl	"12345"	Unterstützt ganze Zahlen und Dezimalzahlen
Datum	"2025-01-01"	Das Standardformat ist yyyy-MM-dd Unterstützt das angegebene Format: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd,yyyy dd MM yyyy
Einfachauswahl	"1"	Beginnt mit der Sortierung bei 0,`0`steht für Option 1,`1`steht für Option 2....
Mehrfachauswahl	"[0,1,2]"	Beginnt mit der Sortierung bei 0,`0`steht für Option 1,`1`steht für Option 2....
Ankreuzen	"0" 、"1"、"2"	`0` - Nicht ausgewählt `1` - Ausgewählt ✓ `2` - Gekreuzt ✗ (muss in der Vorlagenkonfiguration die Option "Kreuzen erlauben" aktiviert sein)
Dropdown-Auswahl	"0"	Sortierung ab 0,`0`steht für Option 1,`1`steht für Option 2....
Bild	"URL"	Es muss ein Bildlink hochgeladen werden
Dynamische Tabelle	[{\"row\":{\"column1\":\"具体内容\"}},{\"row\":{\"column1\":\"具体内容\"}},{\"insertRow\":\"true\",\"row\":{\"column1\":\"Mike\"}}]	row ist die Zeilendaten in der dynamischen Tabelle. Die Anzahl der Zeilen entspricht der Anzahl der Tabellenzeilen, die beim Erstellen der dynamischen Tabelle hinzugefügt wurden. column1 in row ist der Key-Wert der Zelle in der aktuellen Zeile in der Spalte column1, column2 ist der Key-Wert der Zelle in der Spalte column2.
E-Mail	"123456@XX.com"	E-Mail-Adresse