eSign.AIeSign.AI
ศูนย์นักพัฒนา

รับลิงก์หน้าสร้างเทมเพลตไฟล์

POST /esignglobal/v1/templates/create

คำอธิบายอินเทอร์เฟซ

ดึงลิงก์หน้าสร้างเทมเพลตไฟล์

นักพัฒนาสามารถใช้อินเทอร์เฟซนี้เพื่อดึงลิงก์หน้าสร้างเทมเพลตไฟล์ซึ่งมีอายุการใช้งานจำกัด docTemplateCreateUrl,และเปิดลิงก์ดังกล่าว เพื่อให้ผู้ดำเนินการสร้างเทมเพลตไฟล์บนหน้าเว็บโดยอ้างอิงจากไฟล์ที่ระบุ

ข้อควรระวัง

  • fileKey เป็น FILE KEY ที่ได้รับผ่านอินเทอร์เฟซอัปโหลดไฟล์ ใช้สำหรับระบุไฟล์ที่เป็นฐานในการสร้างเทมเพลตครั้งนี้
  • docTemplateType มีค่าเริ่มต้นเป็น 0,หมายถึง เทมเพลต PDF; เมื่อส่งค่า 2 จะหมายถึง เทมเพลต HTML เหมาะสำหรับกรณีที่ต้องการเพิ่มแถวตารางแบบไดนามิกและเติมเนื้อหา
  • อินเทอร์เฟซจะส่งค่ากลับเมื่อเรียกใช้งานสำเร็จ docTemplateCreateUrl,ลิงก์ดังกล่าวมีอายุการใช้งานจำกัด แนะนำให้ใช้งานทันทีหลังจากที่ได้รับมา ไม่แนะนำให้แคชเก็บไว้เป็นเวลานาน
  • นักพัฒนาสามารถ redirectUrl เพื่อกำหนดหน้าที่เปลี่ยนไปหลังจากการสร้างเทมเพลตเสร็จสมบูรณ์

พารามิเตอร์ในการเรียกใช้

ชื่อพารามิเตอร์

ประเภท

จำเป็นต้องกรอกหรือไม่

คำอธิบาย

docTemplateName

string

true

ชื่อเทมเพลตไฟล์ สามารถกำหนดเองได้。

fileKey

string

true

KEY ของไฟล์ รับได้จาก API อัปโหลดไฟล์。

docTemplateType

int

false

ประเภทเทมเพลตไฟล์ ค่าเริ่มต้นคือ 0

0:เทมเพลต PDF。

2:เทมเพลต HTML เหมาะสำหรับกรณีที่ต้องการเพิ่มแถวตารางและเติมข้อมูลแบบไดนามิก。

redirectUrl

string

false

ลิงก์เปลี่ยนหน้าหลังจากสร้างเทมเพลตเสร็จสมบูรณ์ ต้องเป็น URL ที่ถูกต้อง。

ตัวอย่างคำขอ

{
  "docTemplateName": "Sales Contract Template",
  "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
  "docTemplateType": 0,
  "redirectUrl": "https://example.com/template/create/callback"
}

พารามิเตอร์การตอบกลับ

ชื่อพารามิเตอร์

ประเภท

คำอธิบาย

code

int

รหัสสถานะ。

message

string

ข้อมูลการตอบกลับ

data

object

ข้อมูลตอบกลับ

 

docTemplateId

string

ID ของเทมเพลตไฟล์ที่สร้างใหม่

 

docTemplateCreateUrl

string

ลิงก์ไปยังหน้าสร้างเทมเพลตไฟล์ มีอายุการใช้งานจำกัด

ตัวอย่างการตอบกลับ

{
  "code": 0,
  "message": "success",
  "data": {
    "docTemplateId": "template_123456789",
    "docTemplateCreateUrl": "https://app.esignglobal.com/template/create?token=example"
  }
}