楽天API:R-Cabinet 残り容量等の確認

楽天API:R-Cabinet 残り容量等の確認

R-Cabinetの利用状況を確認するAPI

R-Cabinetの契約容量や残容量、フォルダ数といった情報を取得するAPI。
商品情報を作成していく際に利用されるシーンは少ないですが、画像を多用する店舗さんでは【空き容量チェック】機能はうれしい機能です。R-Cabinet系APIにあるCabinet内の画像情報GETと出品中商品の画像情報を照らし合わせれば『容量が規定値以下の時、使っていない画像の削除命令を出す』なんてことも可能となります(cronでの定期実行)。

APIメソッド:cabinet.usage.get

この機能を利用すると、R-Cabinetの利用状況を取得することができます

Endpoint / HTTP Method

Endpoint HTTP Method
https://api.rms.rakuten.co.jp/es/1.0/item/search GET

Request

HTTP Header

 

No Key Value Note
1 Authorization ESA Base64(serviceSecret:licenseKey)

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.usage.get
2 result.cabinetUsageGetResult キャビネット利用情報取得結果 XML:cabinetUsageGetResult 1

 

XML:cabinetUsageGetResult
No Element Description Type Size(byte) Multiplicity Note
1 cabinetUsageGetResult.resultCode 結果コード Integer 4 1
2 cabinetUsageGetResult.MaxSpace 契約容量 (MB) Integer 10 1
3 cabinetUsageGetResult.FolderMax フォルダ数上限 Integer 10 1
4 cabinetUsageGetResult.FileMax フォルダ内画像数上限 Integer 10 1
5 cabinetUsageGetResult.UseSpace 利用容量 (KB) Decimal 10,3
※少数点第3位まで
1
6 cabinetUsageGetResult.AvailSpace 利用可能容量 (KB) Decimal 10,3
※少数点第3位まで
1 契約容量 – 利用容量
7 cabinetUsageGetResult.UseFolderCount 利用フォルダ数 Integer 10 1
8 cabinetUsageGetResult.AvailFolderCount 利用可能フォルダ数 Integer 10 1 フォルダ数上限 – 利用フォルダ数