eSign.AIeSign.AI
Pusat Pengembang

Dapatkan tautan halaman pembuatan templat file

POST /esignglobal/v1/templates/create

Penjelasan Antarmuka

Dapatkan tautan halaman pembuatan template file.

Pengembang dapat menggunakan antarmuka ini untuk mendapatkan tautan halaman pembuatan template file yang memiliki masa berlaku terbatas docTemplateCreateUrl , dan buka tautan tersebut agar operator dapat membuat template file di halaman berdasarkan file yang ditentukan.

Catatan Penting

  • fileKey adalah FILE KEY yang diperoleh melalui antarmuka unggah file, digunakan untuk menentukan file dasar untuk pembuatan template kali ini.
  • docTemplateType secara default adalah 0 , menunjukkan template PDF; masukkan 2 menunjukkan template HTML, cocok untuk skenario menambah baris tabel secara dinamis dan mengisi konten.
  • Setelah pemanggilan antarmuka berhasil, akan mengembalikan docTemplateCreateUrl , tautan ini memiliki masa berlaku terbatas, disarankan untuk segera digunakan setelah diperoleh, tidak disarankan untuk disimpan dalam cache jangka panjang.
  • Pengembang dapat menggunakan redirectUrl untuk menentukan halaman tujuan setelah pembuatan template selesai.

Parameter Permintaan

Nama Parameter

Tipe

Wajib diisi

Keterangan

docTemplateName

string

true

Nama templat file, dapat disesuaikan.

fileKey

string

true

KEY file, diperoleh melalui antarmuka unggah file.

docTemplateType

int

false

Tipe templat file, nilai default adalah 0

0: Templat PDF.

2: Templat HTML, cocok untuk skenario menambahkan baris tabel secara dinamis dan mengisi konten.

redirectUrl

string

false

Tautan alih setelah templat selesai dibuat, harus berupa URL yang valid.

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

Tipe

Keterangan

code

int

Kode status.

message

string

Informasi respons.

data

object

Data respons.

 

docTemplateId

string

ID templat file yang baru dibuat.

 

docTemplateCreateUrl

string

Tautan halaman pembuatan templat file, bersifat sementara.

Contoh respons

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