楽天RMS API取得・設定方法
諸注意
1当アプリをご利用するに辺り、商品APIが必要となりますが、商品APIを利用するために「CSV商品一括編集機能」のご契約が必要となります。
2受注APIを利用すると90日の有効期限がつきますので定期的に更新していただく必要がございます。
有効期限が切れるとライセンスキーがご利用出来なくなるのでご注意下さい。
3当サイトのアプリをご利用するにあたって設定して頂きましたRMS WEB APIのライセンスキーをRMS Service Squareでお申し込まれた製品への反映作業は不要です。
もしRMS Service Square製品のライセンスキーを変更された場合RMS Service Square製品が正常に動作しない可能性がございますのでご注意下さい。
メニュー
RMS WEB SERVICE 利用設定
― RMS Service Squareからお申し込まれた製品をご利用の方へ ―
-
当サイトのアプリをご利用するにあたって設定して頂きましたRMS WEB APIのライセンスキーをRMS Service Square製品への反映作業は不要です。
もしRMS Service Square製品のライセンスキーを変更された場合RMS Service Square製品が正常に動作しない可能性がございますのでご注意下さい。
1RMSにログインします。
2TOPメニューから「拡張サービス一覧」-> 「1.オプション機能利用申込・解約」を選択します。
3「WEB APIサービス」を選択します。
4「WEB APIサービス」メニューから「利用設定」を選択します。
5「利用設定」にある「利用機能編集」を選択します。
6「利用機能編集」画面でご利用アプリに応じて必要な機能にチェックを入れて下さい。
※アプリに必要な機能一覧につきましては4.各アプリ利用API一覧をご参考下さい。
7上記項目をにチェックを入れて「確認する」を押し「登録する」を押します。
8設定完了後、「利用情報」項目にある「SecretKye」と「licensekey」をコピーします。
9らくらくアプリ管理画面の「ショップ設定」にある「【RMS API】シークレットキー」と「【RMS API】ライセンスキー 」にコピーした値を貼り付けます。
※シークレットキーとライセンスキーは大切に保管して下さい。
WEB APIサービス（受注・決済・在庫API）利用設定
2016年9月末より受注・在庫APIの認証方式が変更され、
今までの「WEB APIサービス」からの設定が出来なくなりますのでご注意下さい。
1RMSにログインします。
2TOPメニューから「7.拡張サービス一覧」を選択します。
3「WEB APIサービス」を選択します。
4「WEB APIサービス」メニューから「利用設定」を選択します。
5「利用設定」の「受注API」にある「order.getOrder」にチェックを入れます。
6上記項目をにチェックを入れて「確認する」を押し「登録する」を押して登録完了です。
※注意:受注APIを利用するとライセンスキーに90日の期限が設定されます。
期限が切れると設定してる全てのAPIが利用できなくなるので期限が切れる前にRMSより更新して下さい。
WEB APIサービスの更新
「RMS WEB SERVICE」にて「受注API」を利用する場合、ライセンスキーに90日の有効期限がつきます。
有効期限が切れると、利用設定しているAPI全てが利用できなくなります。
ライセンスキーの更新はRMS上で行う必要があるため、店舗様側で更新していただきますようお願いします。
1RMSにログインします。
2TOPメニューから「7.拡張サービス一覧」を選択します。
3「WEB APIサービス」を選択します。
「利用設定」の「利用情報」にあるライセンスキーの確認をクリックします。
「ライセンス情報」にある「新しいライセンスキーを発行」をクリックすると新しいライセンスキーが発行され期限も延長されます。
各アプリ利用API一覧
●楽天版アイテムランキング
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 受注API※1 | 受注取得API(order.getOrder) |
| 商品API※2 | 商品詳細情報取得API(item.get) |
| カテゴリAPI | カテゴリセットの一覧取得API(shop.categorysets.get) カテゴリ情報の一覧取得API(shop.categories.get) カテゴリ情報取得API(shop.category.get) |
●今コレ実況中継
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 受注API※1 | 受注取得API(order.getOrder) |
| 商品API※2 | 商品詳細情報取得API(item.get) |
●新商品追加自動表示
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 受注API※1 | 受注取得API(order.getOrder) |
| 商品API※2 | 商品詳細情報取得API(item.get) |
●商品レビュー実況中継 / ショップレビュー実況中継
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 商品API※2 | 商品詳細情報取得API(item.get) |
●PRO自動納品書・領収書
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 受注API※1 | 受注取得API(order.getOrder) |
楽天ペイをご利用の店舗様は下記APIの設定を行ってください。
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 楽天ペイ受注API※1 | 受注検索（rpay.order.searchOrder） 受注詳細取得（rpay.order.getOrder） |
クーポン利用オプションをご利用の店舗様は下記のAPIも必要です。
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| クーポンAPI | クーポン情報登録API(coupon.issue) |
●レビュー販促クーポン
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 受注API※1 | 受注取得API(order.getOrder) |
| 商品API | 商品検索取得API(item.search) |
| クーポンAPI | クーポン情報登録API(coupon.issue) クーポン情報削除API(coupon.delete) |
楽天ペイをご利用の店舗様は下記APIの設定を行ってください。
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 楽天ペイ受注API※1 | 受注検索（rpay.order.searchOrder） 受注詳細取得（rpay.order.getOrder） |
●自動タイムセール
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 商品API※2 | 商品情報検索API(item.search) 商品詳細情報取得API(item.get) 商品情報更新API(item.update) |
| カテゴリAPI | カテゴリ情報取得API(shop.category.get) カテゴリ情報更新API(shop.category.update) |
| 店舗管理API | ヘッダー・フッター・レフトナビ情報取得API(shop.dsgn.navitemplate.list.get) |
●レジ横プラス(クロスセル)
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 受注API※1 | 受注情報取得API(order.getOrder) 受注情報更新API(order.updateOrder) 受注更新結果ID取得API(order.getRequestId) 受注更新結果取得API(order.getResult) |
| 在庫API | 在庫情報取得API(inventory.getInventory) 在庫情報一括更新API(inventory.updateInventory) 在庫情報単一更新API(inventory.updateSingleInventory) |
| 商品API※2 | 商品情報検索API(item.search) 商品詳細情報取得API(item.get) 商品情報更新API(item.update) |
| 「楽天あんしんメルアドサービス」必要アプリ |
|---|
| レビュー販促クーポン |
| レジ横プラス(クロスセル) |
※1.受注APIを利用すると90日の有効期限がつきますので定期的に更新していただく必要がございます。
有効期限が切れるとライセンスキーがご利用出来なくなるのでご注意下さい。
※2.商品API(item Search API以外)を利用するために「CSV商品一括編集機能（別途料金10,000円）」のご契約が必要となります。
楽天ペイ切り替えに関して
楽天ペイへ切り替えされた店舗様につきましては下記手順をご参考にAPIの設定を行ってください。
※レジ横プラスは楽天ペイへ対応しておりません。
1RMSにログインします。
2TOPメニューから「7.拡張サービス一覧」を選択します。
3「WEB APIサービス」を選択します。
4「利用設定」にある「利用機能編集」を選択します。
5「利用機能編集」画面にある「楽天ペイ受注API（RakutenPay_OrderApi）」項目で下記画像の項目にチェックを入れ「確認する」を押し「登録する」を押します。
楽天ペイをご利用の店舗様は下記APIの設定を行ってください。
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 楽天ペイ受注API※1 | 受注検索（rpay.order.searchOrder） 受注詳細取得（rpay.order.getOrder） |
※1.受注APIを利用すると90日の有効期限がつきますので定期的に更新していただく必要がございます。
有効期限が切れるとライセンスキーがご利用出来なくなるのでご注意下さい。