eSign.AIeSign.AI
Pusat pembangun

Dapatkan pautan ke halaman pembuatan templat fail

POST /esignglobal/v1/templates/create

Penerangan API

Dapatkan pautan halaman pembuatan templat fail.

Pembangun boleh mendapatkan pautan halaman pembuatan templat fail yang mempunyai tempoh sah melalui API ini docTemplateCreateUrl ,dan buka pautan tersebut supaya pengguna boleh membuat templat fail berdasarkan fail tertentu di halaman tersebut.

Perhatian

  • fileKey ialah KEY fail yang diperoleh melalui API muat naik fail, digunakan untuk menentukan fail asas bagi pembuatan templat kali ini.
  • docTemplateType secara lalai ialah 0 ,menandakan templat PDF; masukkan 2 ia menandakan templat HTML, sesuai untuk senario penambahan bar jadual secara dinamik dan pengisian kandungan.
  • Selepas panggilan API berjaya, akan dipulangkan docTemplateCreateUrl ,pautan ini mempunyai tempoh sah, disyorkan untuk menggunakannya segera selepas diperoleh, tidak disyorkan untuk cache jangka panjang.
  • Pembangun boleh melalui redirectUrl untuk menentukan halaman tuju selepas pembuatan templat selesai.

Parameter Permintaan

Nama Parameter

Jenis

Wajib diisi

Keterangan

docTemplateName

string

true

Nama templat fail, boleh disesuaikan.

fileKey

string

true

KEY fail, diperolehi melalui antara muka muat naik fail.

docTemplateType

int

false

Jenis templat fail, nilai lalai ialah 0

0:Templat PDF.

2:Templat HTML, sesuai untuk senario penambahan baris jadual secara dinamik dan pengisian kandungan.

redirectUrl

string

false

Pautan alih selepas tamat penciptaan templat, mestilah URL yang sah.

Contoh permintaan

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

Parameter respons

Nama parameter

Jenis

Keterangan

code

int

Kod status.

message

string

Maklumat respons.

data

object

Data respons.

 

docTemplateId

string

ID templat fail yang baru dibuat.

 

docTemplateCreateUrl

string

Pautan ke halaman pembuatan templat fail, bersifat sementara.

Contoh respons

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