API リファレンス / ファイル

アップロード先発行

リクエスト例

curl -X POST "https://apiv2.thebase.com/api/files" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "purpose": "item_image",
  "content_type": "image/gif"
}'

リクエストボディ application/json

purpose の値により分岐します。

レスポンス

200 のレスポンスボディ（application/json）:

• file_idstring必須1 文字以上
  アップロードするファイルの参照。送信が完了したあと、このファイルを使うエンドポイント（商品画像の追加など）へそのまま渡します。内容を解釈せず、受け取った文字列のまま保持してください。
• file_expires_atstring (date-time)必須
  ファイルの参照が使える期限。この時刻を過ぎると file_id は受け付けられません。この期限は、まだどこにも登録していないファイルに対するものです。商品画像などに登録したあとのファイルは、この期限の影響を受けません。upload_expires_at は必ずこの時刻以前です。
• upload_urlstring (uri)必須
  ファイル本体の送信先。BASE API ではなくファイルの保管先を指します。この URL へ multipart/form-data で送信してください。
• upload_fieldsobject必須
  ファイル本体と一緒に送信する値の組。すべての項目を、キーと値をそのまま multipart/form-data のフィールドとして送信してください。値を変更したり、一部を省略したりすると送信が拒否されます。ファイル本体は、これらの項目をすべて並べたあと、最後の file フィールドとして送信してください。

  （プロパティ定義なし）

• upload_expires_atstring (date-time)必須
  ファイル本体を送信できる期限。この時刻を過ぎると送信できなくなります。送信を終えたファイルは file_expires_at まで使えます。
• max_bytesinteger必須≥ 0
  送信できるファイルの最大バイト数。用途によって異なります。これを超えるファイルは送信時に拒否されます。

エラー

エラーは application/problem+json の Problem 形式で返します。 認証・スコープ・予期しない内部エラーなど、すべてのエンドポイントに共通のエラーと 構造・判別方法は エラーレスポンス を参照してください。

このエンドポイントが返すその他のエラーは次のとおりです。