Entwicklerzentrum

Datei hochladen

Schritte zum Hochladen von Dateien

Schritt 1:Datei-Upload-Adresse abrufen. Verwenden Sie die über die Schnittstelle zum Abrufen der direkten Datei-Upload-Adresse erhaltene fileUpload-URL.
Schritt 2:Datei hochladen. Verwenden Sie den in Schritt 1 abgerufenen URL, um den Dateistream per HTTP PUT hochzuladen.

【Hinweis】: Der in Schritt 1 übertragene contentType muss mit dem in Schritt 2 im Header übertragenen Content-Type übereinstimmen, da sonst ein Fehler mit dem Fehlercode 403 auftritt.

【Hinweis】: contentMD5 ist kein Pflichtfeld. Wenn contentMD5 und contentType in Schritt 1 übertragen wurden, müssen Content-MD5 und Content-Type auch in den Headern von Schritt 2 übertragen werden und übereinstimmen.

Datei-Upload-Adresse abrufen

POST /esignglobal/v1/files/getUploadUrl

Schnittstellenbeschreibung

Rufen Sie über diese Schnittstelle die Datei-Upload-Adresse ab

Anforderungsparameter

Parametername

Typ

Erforderlich

Beschreibung

fileName

string

true

Dateiname

【Hinweis】: Muss die Dateierweiterung enthalten, da sonst die nachfolgende Initiierung des Umschlags die Validierung nicht besteht.

Beispiel: Vertragsname1.pdf 

Zusätzliche Hinweise:

(1)Der Dateinamensuffix dieses Felds muss mit dem tatsächlichen Dateinamensuffix übereinstimmen. Wenn der hochgeladene Dateityp beispielsweise eine PDF-Datei ist, muss dieser Parameter als „xxx.pdf“ und nicht als „xxx.docx“ übergeben werden.

(2)Der Dateiname darf nicht die folgenden 9 Sonderzeichen enthalten: /\:*"<>|? sowie alle Emoji-Ausdrücke

(3)Nur das .pdf-Dateiformat wird unterstützt

contentMD5

string

false

Content-MD5-Wert der Datei

Zusätzliche Hinweise:

Sie müssen zuerst das 128-Bit-Binär-Array der Datei-MD5 abrufen und dieses Binär-Array dann Base64-codieren.

【Hinweis】Wenn dieser Parameter einen Wert überträgt, muss der in Schritt zwei hochgeladene Datei-Content-MD5 ebenfalls denselben Wert übertragen

contentType

string

true

Inhaltstyp

【Hinweis】Der in Schritt zwei hochgeladene Datei-Content-Type muss ebenfalls denselben Wert übertragen

Beispielanfrage

{
  "fileName": "测试.pdf",
  "contentType": "application/pdf"
}

Antwortparameter

Parametername

Typ

Beschreibung

fileKey

string

Datei fileKey

fileName

string

Dateiname

fileUploadUrl

string

Datei-Upload-Adresse, 60 Minuten gültig

【Hinweis】 Bitte fordern Sie nach Ablauf der Gültigkeit die Upload-Adresse erneut über die Schnittstelle an.

Beispielantwort

{
    "code": "0",
    "data": {
    "fileKey": "xxxxxxxxx",
      "fileName": "签署.pdf",
      "fileUploadUrl": "文件上传地址"
  },
  "message": "成功"
}

 

Datei hochladen

Die über die Schnittstelle „Datei-Upload-Adresse abrufen“ erhaltene fileUpload-URL.

Schnittstellenbeschreibung

Verwenden Sie die bereits abgerufene fileUpload-URL (Datei-Upload-Adresse) und die PUT-Anforderungsmethode, um den Dateistream (binärer Bytestream) auf den Server hochzuladen.

Anfrageparameter

1. Header

Parametername

Typ

Erforderlich

Beschreibung

Content-MD5

string

false

Stimmt mit dem contentMD5-Wert im Body von 【Upload-Datei-Adresse abrufen】 überein

Content-Type

string

true

MIME-Typ der Zieldatei

Zusätzliche Hinweise:

Kann application/octet-stream oder application/pdf sein und muss mit den Anfrageparametern der Schnittstelle zum Abrufen der Upload-Adresse übereinstimmen

2. HTTP-BODY:Binärer Bytestream der hochzuladenden Datei
3. Encode-Methode:

Beispielanfrage

fileName = URLEncoder.encode(fileName, "UTF-8");
// replace special characters
fileName = fileName
  .replaceAll("\\+", "%20")
  .replaceAll("%28", "(")
  .replaceAll("%29", ")")
  .replaceAll("%27", "'")
  .replaceAll("%21", "!")
  .replaceAll("%7E", "~");

Beispielantwort

http_status: 200

 

Datei-Upload-Adresse abrufen
Schnittstellenbeschreibung
Anforderungsparameter
Beispielanfrage
Antwortparameter
Beispielantwort
Datei hochladen
Schnittstellenbeschreibung
Anfrageparameter
Beispielanfrage
Beispielantwort