ファイルをアップロード

ファイルアップロードの手順

ステップ1：ファイルアップロードアドレスの取得。ファイル直接アップロードアドレス取得インターフェースを使用して取得したfileUpload Urlを使用します。

ステップ2：ファイルのアップロード。ステップ1で取得したURLを使用して、HTTP PUT方式でファイルストリームをアップロードします。

【注意】：ステップ1で送信するcontentTypeは、ステップ2のHeaderで送信するContent-Typeと一致する必要があります。そうでない場合、エラーコード403のエラーが発生します。

【注意】：contentMD5は必須項目ではありません。ステップ1でcontentMD5とcontentTypeを送信した場合、ステップ2のHeadersでもContent-MD5とContent-Typeを送信し、一致させる必要があります。

ファイルアップロードアドレスの取得

POST /esignglobal/v1/files/getUploadUrl

インターフェースの説明

このインターフェースを介してファイルアップロードアドレスを取得します

リクエストパラメータ

パラメータ名	タイプ	必須	説明
fileName	string	true	ファイル名【注意】：ファイル拡張子を必ず含めてください。そうしないと、後続のエンベロープの開始が検証に合格しません。例：契約名1.pdf 補足説明：（1）このフィールドのファイル拡張子名と実際のファイル拡張子は一致する必要があります。たとえば、アップロードするファイルタイプがPDFファイルの場合、このパラメータは「xxx.pdf」を渡す必要があり、「xxx.docx」にすることはできません。（2）ファイル名に次の9つの特殊文字を含めることはできません：/\:*"<>\|?およびすべてのemoji絵文字（3）.pdfファイル形式のみをサポート
contentMD5	string	false	ファイルのContent-MD5値補足説明：最初にファイルMD5の128ビットバイナリ配列を取得し、このバイナリをBase64エンコードする必要があります。【注意】このパラメータの伝送値がある場合、ステップ2でアップロードするファイルContent-MD5も同じ値を伝送する必要があります
contentType	string	true	コンテンツタイプ【注意】ステップ2でアップロードするファイルContent-Typeも同じ値を伝送する必要があります

リクエスト例

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

レスポンスパラメータ

パラメータ名	タイプ	説明
fileKey	string	ファイルfileKey
fileName	string	ファイル名
fileUploadUrl	string	ファイルアップロードアドレス、60分以内に有効【注意】期限切れ後は、再度インターフェースをリクエストしてアップロードアドレスを取得してください

レスポンス例

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

ファイルをアップロード

「ファイルアップロードアドレスの取得」インターフェースから取得したfileUpload Urlを使用します。

インターフェースの説明

取得したfileUpload Url（ファイルアップロードアドレス）を使用して、PUTリクエストメソッドでファイルストリーム（バイナリバイトストリーム）をサーバーにアップロードします。

リクエストパラメータ

1. ヘッダー

パラメータ名

タイプ

必須

説明

Content-MD5

string

false

【ファイルアップロードアドレスの取得】BodyのcontentMD5値と一致

Content-Type

string

true

ターゲットファイルのMIMEタイプ

補足説明：

application/octet-streamまたはapplication/pdfを入力できます。アップロードアドレス取得APIのリクエストパラメータと一致する必要があります。

2. HTTP BODY：アップロードするファイルのバイナリバイトストリーム

3. encodeメソッド：

リクエスト例

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

レスポンス例

http_status: 200