ReCORE.co-api

ファイルアップロード

アップロード先URLを取得 (公開ファイル用)

概要

• ファイルアップロード先のURLを取得する
• カタログ画像等のアップロードを想定、機密ファイルのアップロードは厳禁

使い方

1. アップロードするファイルのMIMEタイプをつけて、アップロード先URLを取得する。URLの有効期限は60秒なので速やかに次の手順を実行する。
2. url: 取得したURL method: PUT header: Content-Type: MIMEタイプ body: ファイルバイナリとし、ファイルアップロードを実行する。
3. アップロード先URLのクエリパラメータ部分(?以降)を削除し、ファイルURLとする。
4. ファイルURLをカタログAPIの image_urls などで使用する。

基本情報

• リクエストパス: POST /upload/public
• JWTスコープ: upload:public:store
• 必須個別JWTパラメータ: なし
• レートリミット: 10 rps

body

key	type	説明	制約など
mime_type	string	MIMEタイプ	-

例

• Request

POST /upload/public

{
  "mime_type": "image/jpeg"
}

• Response

{
  "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
  "url": "https://...",
  "mime_type": "image/jpeg"
}

key	type	説明
file_key	string	ファイルキー (使用しない)
url	string	アップロード先URL
mime_type	string	MIMEタイプ

アップロード先URLを取得 (機密ファイル用)

概要

• ファイルアップロード先のURLを取得する
• 免許証画像等のアップロードを想定

使い方

1. アップロードするファイルのMIMEタイプをつけて、アップロード先URLを取得する。URLの有効期限は60秒なので速やかに次の手順を実行する。
2. url: 取得したURL method: PUT header: Content-Type: MIMEタイプ body: ファイルバイナリとし、ファイルアップロードを実行する。
3. ファイルキーを例えば会員ファイル登録で使用する。

基本情報

• リクエストパス: POST /upload/private
• JWTスコープ: upload:private:store
• 必須個別JWTパラメータ: なし
• レートリミット: 10 rps

body

key	type	説明	制約など
mime_type	string	MIMEタイプ	-

例

• Request

POST /upload/private

{
  "mime_type": "image/jpeg"
}

• Response

{
  "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
  "url": "https://...",
  "mime_type": "image/jpeg"
}

key	type	説明
file_key	string	ファイルキー
url	string	アップロード先URL
mime_type	string	MIMEタイプ