Datei herunterladen

GET /esignglobal/v1/envelope/files/download

Schnittstellenbeschreibung

Während des Unterzeichnungsprozesses oder nach Abschluss der Unterschrift können die Dokumente im Umschlag heruntergeladen werden. Der Download während des Unterzeichnungsprozesses unterliegt den Konfigurationen für Prozessdownloads, Downloadberechtigungen und Regeln zur Sichtbarkeit der Dokumente. Wenn für die Dokumente während des Unterzeichnungsprozesses ein asynchroner Wasserzeichen-Compositing-Prozess erforderlich ist, gibt die Schnittstelle eine ID für den Downloadauftrag zurück. Kunden können das Endergebnis der Datei über die Schnittstelle zum Abfragen von Downloadaufträgen oder über Callbacks bei Abschluss von Downloadaufträgen abrufen.

Anforderungsparameter

Parametername	Typ	Pflichtfeld	Beschreibung
envelopeId	string	true	Umschlag-ID
downloadType	string	false	Datei-Download-Formattyp: zip (Standard): Gibt einen Downloadlink für das Archiv zurück list: Gibt eine Dateiliste zurück

Anfragebeispiel

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

Antwortparameter

Parametername		Typ	Beschreibung
envelopeId		string	Envelope-ID
envelopeStatus		int	Envelope-Status 0- Erstellt (Entwurf) 1- Unterzeichnung läuft 2- Abgeschlossen 3- Abgelaufen 5- Widerrufen
taskId		string	ID des Download-Auftrags. Wird nur zurückgegeben, wenn die Envelope-Unterzeichnung läuft und die Datei einen asynchron generierten Wasserzeichen benötigt. [Hinweis] Wenn taskId zurückgegeben wird, werden keine Dateiergebnisfelder wie downloadUrl oder envelopeFiles zurückgegeben.
downloadUrl		string	Download-URL der Datei [Hinweis] Gültig für 30 Minuten. Nach Ablauf bitte erneut eine API-Anfrage stellen, um die Download-URL zu erhalten. Wird zurückgegeben, wenn downloadType=zip ist und die Dateiergebnisse synchron zurückgegeben werden können; wird nicht zurückgegeben, wenn taskId zurückgegeben wird.
envelopeFiles		array	Sammlung der Envelope-Dateien [Hinweis] Wird zurückgegeben, wenn downloadType=list ist und die Dateiergebnisse synchron zurückgegeben werden können; wird nicht zurückgegeben, wenn taskId zurückgegeben wird.
	fileType	string	Dateityp CONTRACT- Unterzeichnete Datei ATTACHMENT- Anhang CERTIFICATE- Zertifikat COMBINED- PDF-Datei, die die „Unterzeichnete Datei“ und den „Unterschriebenen Nachweis“ zusammenführt; wird zurückgegeben, wenn die Option „Herunterladen der zusammengeführten Briefumschlag-Dateien“ aktiviert ist
	fileName	string	Dateiname
	downloadUrl	string	Download-URL der Datei (gültig für 60 Minuten)

Beispielantwort

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

Wenn das Dokument unterzeichnet wird und ein Wasserzeichen asynchron hinzugefügt werden muss, lautet die Beispielantwort wie folgt:

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