楽天API：R-Cabinet内画像の上書き
R-Cabinet内の画像を上書きするAPI
画像IDの指示で画像の上書き、画像名の変更を行うAPI。
楽天市場サーバー内で画像はIDで管理されているため、同じIDに全く別の画像を別の名前で保存する事も可能。画像名を変更した場合HTMLのリンクは切れる事が予想されるので操作には注意が必要。
APIメソッド：cabinet.file.update
この機能を利用すると、画像IDを指定して画像情報を更新することができます。
Endpoint / HTTP Method
| Endpoint | HTTP Method |
|---|---|
| https://api.rms.rakuten.co.jp/es/1.0/cabinet/file/update | POST |
Request
HTTP Header
| No | Key | Value | Note |
|---|---|---|---|
| 1 | Authorization | ESA Base64(serviceSecret:licenseKey) | |
| 2 | Content-Type | multipart/form-data |
HTTP Body
Form Values
| No | Key | Description | Mandatory | Type | Note |
|---|---|---|---|---|---|
| 1 | xml | リクエスト | 〇 | String | APIのパラメータ |
| 2 | file | 画像情報 | 〇 | binary | HTMLのフォームを使ったファイルアップロード 1ファイルあたりの重さ ： 2MBまで 1ファイルあたりのサイズ ： 横1600×縦1200pixelまで 登録可能な形式 ： JPEG、GIF、アニメーションGIF、PNG、TIFF、BMP ※PNG、TIFF、BMP形式の画像はJPEGに変換 (その他の形式はエラー) |
XML:request
| No | Element | Description | Type | Size(byte) | Mandatory | Multiplicity | Note |
|---|---|---|---|---|---|---|---|
| 1 | request.fileUpdateRequest | 画像情報更新要求 | XML: fileUpdateRequest | – | 〇 | 1 |
XML:fileUpdateRequest
| No | Element | Description | Type | Size(byte) | Mandatory | Multiplicity | Note |
|---|---|---|---|---|---|---|---|
| 1 | fileUpdateRequest.file | 画像情報 | XML:file | – | 〇 | 1 |
XML:file
| No | Element | Description | Type | Size(byte) | Mandatory | Multiplicity | Note |
|---|---|---|---|---|---|---|---|
| 1 | file.fileId | 画像ID | Integer | 10 | 0 | 1 | |
| 2 | file.fileName | 更新画像名 | String | 50 | ※1 | 0,1 | 50バイト以内（全角25文字以内/半角50文字以内） 使用禁止文字：機種依存文字（コントロールコード除く）、半角カタカナ 全角スペース → 半角スペースに変換 スペースのみは不可 前後にスペースがある場合は、スペースを自動削除 タグは無効（入力した場合は、タグと判断されたものを削除して更新） |
| 3 | file.filePath | 更新file名 | String | 20 | ※1 | 0,1 | 20バイト以内（半角20文字以内） renameのみmoveはしない 登録時にdefaultで設定した場合、img + 別数字,imgrc + 別数字の形式へは変更不可 登録時と同じ値は指定不可 入力可能な文字は、半角英数字（小文字）/記号は「-」「_」のみ 使用禁止文字：機種依存文字（コントロールコード含む）、img+8桁の数字、imgrc+10桁の数字 スペースのみ/字間にスペースは不可(スペースのみの場合は更新しない) 前後にスペースがある場合は、スペースは自動削除 タグは無効（入力した場合はタグと判断されたものを削除して更新） |
※1. file、fileName、filePathの項目のうち、最低でも1つは指定してください。
入力のない項目は更新されず、既存のデータのままとなります。
Response
HTTP Header
| No | Key | Value |
|---|---|---|
| 1 | Content-Type | text/xml |
HTTP Body
XML:result
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | result.status | ステータス | XML : status | – | 1 | interfaceId=cabinet.file.update |
| 2 | result.cabinetFileUpdateResult | 画像情報更新結果 | XML : cabinetFileUpdateResult | – | 1 |
XML:cabinetFileUpdateResult
| No | Element | Description | Type | Size(byte) | Multiplicity | Note |
|---|---|---|---|---|---|---|
| 1 | cabinetFileUpdateResult.resultCode | 結果コード | Integer | 4 | 1 |
-
前の記事
楽天API：フォルダを指定し画像を登録 2018.09.14
-
次の記事
楽天API：画像フォルダの新規作成 2018.09.14