Pusat Pengembang

Unduh File

GET /esignglobal/v1/envelope/files/download

Deskripsi API

Pengunduhan file yang dikemas di dalam amplop hanya didukung ketika amplop telah selesai.

Parameter Permintaan

Nama Parameter

Tipe

Wajib

Keterangan

envelopeId

string

true

ID Amplop

downloadType

stringfalse

Tipe format pengunduhan file:  

  • zip (default): mengembalikan tautan pengunduhan arsip terkompresi
  • list: mengembalikan daftar file 

Contoh Permintaan

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

Parameter Respons

Nama Parameter

Tipe

Keterangan

envelopeId

string

ID Amplop

envelopeStatus

int

Status Amplop

0-Dibuat (Draf)

1-Sedang Ditandatangani

2-Selesai

3-Kadaluarsa

5-Dibatalkan

downloadUrl

string

Alamat Unduhan File

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

Dikembalikan saat downloadType=zip

envelopeFiles

array

Kumpulan File Amplop

Kumpulan File Amplop

【Perhatian】Dikembalikan saat downloadType=list

 

fileType

string

Jenis File

CONTRACT-Dokumen yang ditandatangani

ATTACHMENT-Lampiran

CERTIFICATE-Sertifikat

COMBINED-File PDF yang menggabungkan “dokumen yang ditandatangani” dan “bukti penyelesaian penandatanganan”, dikembalikan ketika “pengunduhan gabungan file envelope” diaktifkan

 

fileName

string

Nama file

 

downloadUrl

string

URL unduh file (berlaku selama 60 menit)

Contoh respons

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