File


サポートされる操作:

File Object

プロパティ
説明
id

型: string
ファイルを参照するための一意な識別子



type

型: filetype [Enum]
ファイル形式(例: jpg、pdf など)
purpose

型: filePurpose [Enum]
ファイルの利用目的(例: disputeEvidence)



size

型: int
ファイルサイズ(バイト単位)
uploadTimestamp

型: dateTime
ISO 8601形式でのアップロード日時
url

型: String
ファイルのダウンロードURL
urlExpirationTimestamp

型: dateTime
ダウンロードURLの有効期限

Enum

filePurpose


説明
disputeEvidence
提供されたファイルはディスピュート(異議申し立て)の証拠として使用されます

Upload File 詳細

紛争証拠やその他の文書作成に必要なファイルをアップロードして管理します。Upload File APIは、一般的なファイル形式をサポートし、安全なアップロードURLを提供します。APIは、ファイルを安全にアップロードするための2段階のプロセスを提供します。

Step 1: Upload URL取得

まず安全なアップロードURLをリクエストします。:

Request

Request body

{
    "type" : "jpg",
    "purpose" : "disputeEvidence"
}

Request parameters

名前
ロケーション
説明
x-amz-pay-idempotency-key
(required)

Type: String
Header
重複アップロードを防ぐための一意のキー。idempotencyキーの作成と使用に関する詳しいガイダンスについては、別途idempotencyを参照してください。
type

Type: String
Body
ファイルフォーマット(jpg, png, pdf)
purpose

Type: String
Body
アップロード理由(disputeEvidence)

Supported file types

ファイルタイプ
説明
Content-Type
csv
CSV files
text/csv
pdf
PDF documents
application/pdf
xls/xlsx
Excel spreadsheets
application/vnd.ms-excel (xls)
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (xlsx)
doc/docx
Word documents
application/msword (doc)
application/vnd.openxmlformats-officedocument.wordprocessingml.document (docx)
ods
OpenDocument spreadsheets
application/vnd.oasis.opendocument.spreadsheet
jpg/png
Image files
image/jpeg (jpg)
image/png (png)

Response

{
    "id": "file_sdcjscbjckndjhckj", 
    "type" : "jpg",
    "purpose": "disputeEvidence",
    "uploadTimestamp": 20190714T155300Z,
    "url": "https://pay-api.amazon.jp/v1/files/file_sdcjscbjckndjhckj/contents",
    "urlExpirationTimeStamp: 20190714T155300Z
}

Step 2: ファイルアップロード

レスポンスにあるURLにファイルを送信します::

curl "YOUR_PRESIGNED_URL" \
-X PUT \
-H "Content-Type: application/pdf" \
-T "/path/to/file"

ファイル要件:

  • 最大サイズ:2MB
  • ファイルは紛争の証拠として関連性があるものでなければなりません

アップロード後、Upload File APIのレスポンスにある fileId を使用します。