POST /esignglobal/v1/templates/createFileByTemplate
คำอธิบายอินเทอร์เฟซ
อิงตามหมายเลขเทมเพลตสัญญาtemplateIdและตัวควบคุมในเทมเพลตเพื่อเติมเนื้อหาที่กำหนดเอง และสร้างไฟล์ PDF ในที่สุดแบบอะซิงโครนัส
โปรดตรวจสอบให้แน่ใจว่าสถานะเทมเพลตเปิดใช้งานอยู่ก่อนที่จะโทร
พารามิเตอร์คำขอ
ชื่อพารามิเตอร์ | ประเภท | จำเป็นหรือไม่ | คำอธิบาย |
templateId | string | true | ID เทมเพลตสัญญา |
fileName | string | false | ชื่อไฟล์ที่สร้างขึ้น หมายเหตุ: ชื่อไฟล์ต้องไม่มีอักขระพิเศษ 9 ตัวต่อไปนี้: / \ : * " < > | ？และอีโมจิทั้งหมด |
fields | array | false | ข้อมูลรายการตัวควบคุมในเทมเพลต (ส่งค่าโดยเลือกอย่างใดอย่างหนึ่งระหว่าง ID ตัวควบคุมและคีย์ตัวควบคุม) |
| fieldId | string | false | ID ตัวควบคุม (สร้างโดยอัตโนมัติโดยระบบ eSignGlobal เมื่อตั้งค่าเทมเพลตสัญญา) |
| fieldKey | string | false | คีย์ของคอนโทรล (ผู้ใช้กำหนดเองเมื่อตั้งค่าเทมเพลตสัญญา) |
| fieldValue | string | false | ค่าที่จะเติมในคอนโทรล
（1）สามารถเติมตามประเภทของคอนโทรลได้
（2）เมื่อเติมคอนโทรลตารางแบบไดนามิก หากต้องการเพิ่มข้อมูลในแถวใหม่ ค่าพารามิเตอร์ insertRow จะต้องส่งค่าเป็น true |
callBackUrl | string | false | ที่อยู่ Callback (ความยาวสูงสุด 500) ต้องเป็นที่อยู่ https ที่ถูกต้อง |
ตัวอย่างคำขอ
{
"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"
}
]
}
พารามิเตอร์การตอบสนอง
ชื่อพารามิเตอร์ | ประเภท | คำอธิบาย |
taskId | string | ID งานรวมไฟล์ |
ตัวอย่างการตอบสนอง
{
"code": "0",
"data": {
"taskId": "7e6d1125dc164fa4b2c268f8bb809dea"
},
"message": "success"
}
คำอธิบายตัวอย่างการเติมคอนโทรล
ประเภทของคอนโทรล | ตัวอย่างค่าที่เติมในคอนโทรล | คำอธิบายเฉพาะ |
ข้อความบรรทัดเดียว | "ข้อความเฉพาะ XXXXX" | ข้อความเฉพาะที่เติม |
ข้อความหลายบรรทัด | "ข้อความหลายบรรทัด\nข้อความหลายบรรทัด" | ข้อความเฉพาะที่เติม\n ขึ้นบรรทัดใหม่ |
ตัวเลข | "12345" | รองรับจำนวนเต็มและทศนิยม |
วันที่ | "2025-01-01" | รูปแบบเริ่มต้นคือ yyyy-MM-dd รองรับรูปแบบที่ระบุ: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd dd.MM.yyyy MM dd,yyyy dd MM yyyy |
ตัวเลือกเดียว | "1" | เรียงลำดับจาก 0,0แสดงถึงตัวเลือกที่ 1,1แสดงถึงตัวเลือกที่ 2.... |
เลือกได้หลายรายการ | "[0,1,2]" | เรียงลำดับจาก 0,0แสดงถึงตัวเลือกที่ 1,1แสดงถึงตัวเลือกที่ 2.... |
ทำเครื่องหมาย | "0" 、"1"、"2" | 0 - ไม่ได้เลือก
1 - เลือกแล้ว ✓
2 - กากบาท ✗ (ต้องเปิดตัวเลือก "อนุญาตให้กากบาท" ในการกำหนดค่าเทมเพลต)
|
เลือกแบบเลื่อนลง | "0" | เรียงลำดับจาก 00แสดงถึงตัวเลือก 11แสดงถึงตัวเลือก 2.... |
รูปภาพ | "URL" | ต้องอัปโหลดลิงก์รูปภาพ |
ตารางไดนามิก | [{\"row\":{\"column1\":\"具体内容\"}},{\"row\":{\"column1\":\"具体内容\"}},{\"insertRow\":\"true\",\"row\":{\"column1\":\"Mike\"}}] | row คือข้อมูลแถวในตารางไดนามิก จำนวน row คือจำนวนแถวของตารางที่เพิ่มเมื่อสร้างตารางไดนามิก column1 ใน row คือค่า Key ของเซลล์ในคอลัมน์ column1 ของแถวปัจจุบัน column2 คือค่า Key ของเซลล์ในคอลัมน์ column2 |
อีเมล | "123456@XX.com" | ที่อยู่อีเมล |
