Scarica file

GET /esignglobal/v1/envelope/files/download

Descrizione dell'interfaccia

Durante la firma del pacco o al termine della stessa, è possibile scaricare i file contenuti nel pacco. Il download durante la fase di firma è soggetto alle configurazioni di download del flusso, ai permessi di download e alle regole di visibilità dei file; se per i file in fase di firma è necessaria la composizione asincrona di filigrane, l'interfaccia restituisce un ID di attività di download, che il cliente può utilizzare tramite l'interfaccia di query delle attività di download o la callback di completamento delle attività di download per ottenere i risultati dei file.

Parametri di richiesta

Nome del parametro	Tipo	Obbligatorio	Descrizione
envelopeId	string	true	ID del pacco
downloadType	string	false	Tipo di formato di download del file: zip (predefinito): restituisce il link di download del file compresso list: restituisce l'elenco dei file

Esempio di richiesta

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

Parametri di risposta

Nome del parametro		Tipo	Descrizione
envelopeId		string	ID del pacco
envelopeStatus		int	Stato del pacco 0- Creato (bozza) 1- In fase di firma 2- Completato 3- Scaduto 5- Revocato
taskId		string	ID dell'attività di download. Restituito solo quando il pacco è in fase di firma e i file richiedono la composizione asincrona con filigrana. [Nota] Quando viene restituito taskId, non vengono restituiti i campi dei risultati dei file come downloadUrl ed envelopeFiles.
downloadUrl		string	URL di download del file [Nota] Valido per 30 minuti; dopo la scadenza, richiedi nuovamente l'interfaccia per ottenere l'URL di download Restituito quando downloadType=zip e i risultati dei file possono essere restituiti in modo sincrono; non restituito quando viene fornito taskId.
envelopeFiles		array	Collezione dei file del pacco [Nota] Restituito quando downloadType=list e i risultati dei file possono essere restituiti in modo sincrono; non restituito quando viene fornito taskId.
	fileType	string	Tipo di file CONTRACT-File da firmare ATTACHMENT-Allegato CERTIFICATE-Certificato COMBINED-File PDF che unisce il "file da firmare" e la "prova di firma completata", restituito quando l'opzione "scarica file dell'involucro uniti" è attivata
	fileName	string	Nome del file
	downloadUrl	string	URL di download del file (valido per 60 minuti)

Esempio di risposta

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

Quando il documento è in fase di firma e richiede la composizione asincrona con filigrana, l'esempio di risposta è il seguente:

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