eSign.AIeSign.AI
Sentro ng developer

I-download ang file

GET /esignglobal/v1/envelope/files/download

Deskripsyon ng Interface

Suportado ang pag-download ng mga file sa loob ng envelope habang ito ay nasa proseso ng pag-sign o tapos na. Ang pag-download habang nagsisign ay nakadepende sa configuration ng download ng proseso, permissions sa pag-download, at mga patakaran sa visibility ng file; kung kinakailangan ng watermark na asynchronous synthesis para sa mga file habang nagsisign, ibabalik ng interface ang task ID sa pag-download, at maaaring kunin ng customer ang resulta ng file gamit ang interface sa pagtatanong tungkol sa task sa pag-download o ang callback kapag natapos na ang task sa pag-download.

Mga Parameter ng Hiling

Pangalan ng Parameter

Uri

Kailangan

Paliwanag

envelopeId

string

true

ID ng Envelope

downloadType

stringfalse

Uri ng format sa pag-download ng file:  

  • zip (default): Ibalik ang link para sa pag-download ng compressed package
  • list: Ibalik ang listahan ng mga file 

Halimbawa ng Hiling

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

Mga Parameter ng Responso

Pangalan ng Parameter

Uri

Paliwanag

envelopeId

string

ID ng Envelope

envelopeStatus

int

Estado ng Envelope

0-Nilikha (Draft)

1-Nagsasailalim sa Pagpirma

2-Natapos na

3-Lumipas na ang Expiry

5-Na-revoke

taskId

string

ID ng Task sa Pag-download. Ito ay ibinabalik lamang kapag ang envelope ay nasa estado ng pagpirma at kailangan ng asynchronous na pagbuo ng watermark para sa mga file.

[Paalala] Kapag ibinalik ang taskId, hindi ibinabalik ang mga field ng resulta ng file tulad ng downloadUrl at envelopeFiles.

downloadUrl

string

URL para sa Pag-download ng File

[Paalala] Valid lamang sa loob ng 30 minuto; kung lumipat na ang expiry, mangyaring humingi muli ng interface upang makuha ang URL ng pag-download.

Ibinabalik kapag downloadType=zip at maaaring sabay-sabay na ibalik ang resulta ng file; hindi ibinabalik ang field na ito kapag ibinalik ang taskId.

envelopeFiles

array

Koleksyon ng mga File ng Envelope

[Paalala] Ibinabalik kapag downloadType=list at maaaring sabay-sabay na ibalik ang resulta ng file; hindi ibinabalik ang field na ito kapag ibinalik ang taskId.

 

fileType

string

Uri ng File

CONTRACT-Lagdaang File

ATTACHMENT-Attachment

CERTIFICATE-Certificate

COMBINED-PDF file na pinagsama ang 'Signed File' at 'Proof of Completion', ibinabalik kapag naka-enable ang 'Envelope File Merge Download'

 

fileName

string

Pangalan ng File

 

downloadUrl

string

Link para sa Pag-download ng File (valid sa loob ng 60 minuto)

Halimbawa ng Response

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

Kapag nasa proseso ng pag-sign at kailangan ng asynchronous na pagsasama ng watermark, narito ang halimbawa ng response:

{
    "code": "0",
    "data": {
      "envelopeId": "xxxx",
      "envelopeStatus": 1,
      "taskId": "task1234567890"
  },
  "message": "success"
}