eSign.AIeSign.AI
Trung tâm nhà phát triển

Lấy liên kết trang tạo mẫu tệp

POST /esignglobal/v1/templates/create

Mô tả giao diện

Lấy liên kết trang tạo mẫu tài liệu.

Nhà phát triển có thể sử dụng giao diện này để lấy một liên kết trang tạo mẫu tài liệu có thời hạn docTemplateCreateUrl, và mở liên kết đó để người vận hành tạo mẫu tài liệu trên trang dựa trên tệp đã chỉ định.

Lưu ý

  • fileKey là KEY tệp được lấy qua giao diện tải lên tệp, dùng để chỉ định tệp làm cơ sở cho việc tạo mẫu lần này.
  • docTemplateType mặc định là 0, biểu thị mẫu PDF; truyền vào 2 thì biểu thị mẫu HTML, phù hợp với các tình huống cần thêm dòng bảng động và điền nội dung.
  • Sau khi gọi giao diện thành công sẽ trả về docTemplateCreateUrl, liên kết này có tính thời hạn, khuyến nghị sử dụng ngay sau khi lấy, không nên lưu trữ lâu dài trong bộ nhớ đệm.
  • Nhà phát triển có thể thông qua redirectUrl để chỉ định trang chuyển hướng sau khi tạo mẫu hoàn tất.

Tham số yêu cầu

Tên tham số

Loại

Có bắt buộc

Mô tả

docTemplateName

string

true

Tên mẫu tệp, có thể tùy chỉnh.

fileKey

string

true

KEY của tệp, lấy qua giao diện tải lên tệp.

docTemplateType

int

false

Loại mẫu tệp, giá trị mặc định là 0

0: Mẫu PDF.

2: Mẫu HTML, phù hợp với các tình huống cần thêm dòng bảng động và điền nội dung.

redirectUrl

string

false

Liên kết chuyển hướng sau khi tạo mẫu hoàn tất, phải là URL hợp lệ.

Ví dụ yêu cầu

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

Tham số phản hồi

Tên tham số

Loại

Mô tả

code

int

Mã trạng thái.

message

string

Thông tin phản hồi.

data

object

Dữ liệu phản hồi.

 

docTemplateId

string

ID của mẫu tệp mới tạo.

 

docTemplateCreateUrl

string

Liên kết đến trang tạo mẫu tệp, có hiệu lực trong thời gian nhất định.

Ví dụ phản hồi

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