Pusat Pengembang

Unduh Berkas

GET /esignglobal/v1/envelope/files/download

Deskripsi Antarmuka

Hanya ketika amplop sudah selesai, dukungan untuk mengemas unduhan file di dalam amplop.

Parameter Permintaan

Nama Parameter

Jenis

Wajib Diisi

Keterangan

envelopeId

string

true

ID Amplop

downloadType

stringfalse

Jenis format unduhan file:  

  • zip (default): Mengembalikan tautan unduhan paket kompresi
  • list: Mengembalikan daftar file 

Contoh Permintaan

GET https://……/esignglobal/v1/envelope/files/download?envelopeId=flow1234567890&downloadType=list

Parameter Respons

Nama Parameter

Jenis

Keterangan

envelopeId

string

ID Amplop

envelopeStatus

int

Status Amplop

0-Dibuat (draf)

1-Dalam Penandatanganan

2-Selesai

3-Kedaluwarsa

4-Ditolak

5-Dibatalkan

downloadUrl

string

Alamat Unduhan File

【Perhatian】Berlaku dalam 30 menit, harap minta ulang antarmuka untuk mendapatkan alamat unduhan setelah kedaluwarsa

Dikembalikan ketika downloadType=zip

envelopeFiles

array

Kumpulan File Amplop

Kumpulan File Amplop

【Perhatian】Dikembalikan ketika downloadType=list

 

fileType

string

Tipe File

CONTRACT-Dokumen yang Ditandatangani

ATTACHMENT-Lampiran

CERTIFICATE-Sertifikat

 

fileName

string

Nama File

 

downloadUrl

string

Tautan Unduhan File (Berlaku dalam 60 Menit)

Contoh Respons

{
    "code": "0",
    "data": {
    "envelopeId": "xxxx",
      "downloadUrl": "下载地址",
      "envelopeStatus": 2
  },
  "message": "success"
}

 

Deskripsi Antarmuka
Parameter Permintaan
Contoh Permintaan
Parameter Respons
Contoh Respons