Pusat pembangun

Isi templat untuk menjana fail

POST /esignglobal/v1/templates/createFileByTemplate

Deskripsi Antara Muka

Berdasarkan nombor templat kontraktemplateIddan kawalan dalam templat untuk mengisi kandungan tersuai, dan akhirnya menjana fail PDF secara tak segerak.

Sila pastikan status templat diaktifkan sebelum membuat panggilan

Parameter Permintaan

Nama Parameter

Jenis

Wajib Diisi

Keterangan

templateId

string

true

ID Templat Kontrak

fileName

string

false

Nama fail yang dijana

Nota: Nama fail tidak boleh mengandungi 9 aksara khas berikut: / \ : * " < > | ?dan semua emoji

fields

array

false

Senarai maklumat kawalan dalam templat (pilih salah satu antara ID kawalan dan Kunci kawalan untuk menghantar nilai)

 

fieldId

string

false

ID Kawalan (dijana secara automatik oleh sistem eSignGlobal semasa menetapkan templat kontrak)

 

fieldKey

string

false

Kunci Kawalan (Disesuaikan oleh pengguna semasa menetapkan templat kontrak)

 

fieldValue

string

false

Nilai pengisian kawalan
(1)Boleh diisi mengikut jenis kawalan;
(2)Apabila mengisi kawalan jadual dinamik, jika anda perlu menambah baris data baharu, nilai parameter insertRow mesti dihantar sebagai true

callBackUrl

string

false

Alamat panggilan balik (panjang maksimum 500), mestilah alamat https yang sah

Contoh permintaan

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

Parameter respons

Nama parameter

Jenis

Keterangan

taskId

string

ID tugas sintesis fail

Contoh respons

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

Keterangan contoh pengisian kawalan

Jenis Kawalan

Contoh Nilai Pengisian Kawalan

Penerangan Terperinci

Teks Satu Baris

"Teks khusus XXXXX"

Teks khusus yang diisi

Teks Berbilang Baris

"Teks berbilang baris\nTeks berbilang baris"

Teks khusus yang diisi,\n untuk membuat baris baharu

Nombor

"12345"

Menyokong integer dan perpuluhan

Tarikh

"2025-01-01"

Format lalai ialah yyyy-MM-dd

Menyokong format yang ditentukan:

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd,yyyy

dd MM yyyy

Pilihan Tunggal

"1"

Diisih bermula dari 0,0mewakili pilihan 1,1mewakili pilihan 2....

Pelbagai Pilihan

"[0,1,2]"

Diisih bermula dari 0,0mewakili pilihan 1,1mewakili pilihan 2....

Tanda semak

"0" 、"1"、"2"

0 - Tidak dipilih

1 - Dipilih ✓

2 - Bertanda pangkah ✗ (Perlu menghidupkan pilihan "Benarkan tanda pangkah" dalam konfigurasi templat)

Pilihan menu lungsur

"0"

Susunan bermula dari 0,0mewakili pilihan 1,1mewakili pilihan 2....

Gambar

"URL"

Perlu memuat naik pautan gambar

Jadual dinamik

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

row ialah data baris dalam jadual dinamik, bilangan row ialah bilangan baris jadual yang ditambahkan semasa membuat jadual dinamik. column1 dalam row ialah nilai Kunci sel pada lajur column1 dalam baris semasa, column2 ialah nilai Kunci sel pada lajur column2.

E-mel

"123456@XX.com"

Alamat e-mel

Deskripsi Antara Muka
Parameter Permintaan
Contoh permintaan
Parameter respons
Contoh respons
Keterangan contoh pengisian kawalan