楽天版
楽天RMS API取得・設定方法
諸注意
1楽天ペイ受注APIや受注APIを利用すると90日の有効期限がつきますので定期的に更新していただく必要がございます。
有効期限が切れるとライセンスキーがご利用出来なくなるのでご注意ください。
2当サイトのアプリをご利用するにあたって設定して頂きましたRMS WEB APIのライセンスキーをRMS Service Squareでお申し込まれた製品への反映作業は不要です。
もしRMS Service Square製品のライセンスキーを変更された場合RMS Service Square製品が正常に動作しない可能性がございますのでご注意ください。
WEB APIサービス利用申請
WEB APIサービスが利用申請済みの場合は「WEB APIサービス利用設定」をご確認ください。
1WEB APIサービスを選択
楽天RMSにログインし、レフトナビの[拡張サービス一覧]＞[4 WEB APIサービス]を選択します。
2申込、利用規約確認
RMS WEB SERVICE画面が開きます。
レフトナビの「1-2 申込、利用規約確認」を選択します。
3規約に同意する
申込、利用規約確認の確認画面において内容をご確認の上「規約に同意する」ボタンをクリックすると利用申請画面へ遷移します。
4サービスの利用申込定
「申込、利用規約確認」画面で「申込む」のボタンをクリックして申込完了です。
申込完了後、店舗詳細情報内の「店舗連絡先メールアドレス」にご登録いただいたメールアドレス宛てにお申込完了のメールが送付されます。
WEB APIサービス利用設定
1WEB APIを選択
RMS WEB SERVICEのレフトナビから「WEB API」を選択します。
2利用機能編集
「利用設定」にある「利用機能編集」を選択します。
3ご利用になりたいWEB APIを選択
「利用機能編集」画面でご利用アプリに応じて必要な機能にチェックを入れます。
※レビュー販促クーポンで必要なAPIは下記をご確認ください。
4確認する
画面下の「確認する」ボタンをクリックします。
※一度利用設定をされますと、設定を解除することはできません。
店舗様にてご利用予定の機能を確認後に設定してください。
PRO自動納品書・領収書で必要なAPIは下記になります。
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 楽天ペイ受注API※1 | 受注検索（rpay.order.searchOrder） 受注詳細取得（rpay.order.getOrder） |
楽天ペイを利用していない店舗様は下記APIの設定を行ってください。
| RMS WEB SERVICE サービス名 | API名 |
|---|---|
| 受注API※1 | 受注取得API(order.getOrder) |
※1.受注APIを利用すると90日の有効期限がつきますので定期的に更新していただく必要がございます。
有効期限が切れるとライセンスキーがご利用出来なくなるのでご注意下さい。
5利用設定の完了
選択内容を確認して最後に画面下の「登録する」ボタンをクリックすると利用設定が完了します。
※設定後、利用可能となるまで10分～30分程度タイムラグがありますので、時間をおいて設定した機能をご利用ください。
6キー情報をコピー
設定完了後、「利用情報」項目にある「SecretKye」と「licensekey」をコピーします。
7ショップ設定
らくらくアプリ管理画面の「ショップ設定」にある「serviceSecret」と「licenseKey」にコピーした値を貼り付けます。
※serviceSecretとlicenseKeyは大切に保管してください。
ライセンスキーの更新
「RMS WEB SERVICE」にて「受注API」を利用する場合、ライセンスキーに90日の有効期限がつきます。
有効期限が切れると、利用設定しているAPI全てが利用できなくなります。
ライセンスキーの更新はRMS上で行う必要があるため、店舗様側で更新していただきますようお願いします。
1WEB APIを選択
RMS WEB SERVICEのレフトナビから「WEB API」を選択します。
2確認をクリック
「利用設定」の「利用情報」にあるライセンスキーの確認をクリックします。
3新しいライセンスキーを発行
「ライセンス情報」の「新しいライセンスキーを発行」ボタンをクリックし、「新しいlicenseKeyを発行しますか？」のメッセージボックスが表示された場合は「OK」を選択すると新しいライセンスキーが発行され、画面に表示されます。
新しいライセンスキー（licenseKey）のキー情報をコピーします。
4ショップ設定
らくらくアプリ管理画面の「ショップ設定」にある「licensekey」にコピーした値を貼り付けます。
※serviceSecretとlicenseKeyは大切に保管してください。