楽天APIライセンスキーの登録/更新

※既に設定済みで楽天ペイに切り替える際の対応についてはこちらをご確認ください。
 


1.WEB API サービスの利用申請
2.ECステーションへのライセンスキー登録
3.ライセンスキーの更新(3ヵ月ごと)



 

1. WEB API サービスの利用申請

楽天WEB API サービス(無料)に利用申請を行っていただき
サービスシークレット(serviceSecret)とライセンスキー(licenseKey)を
RMSにて取得しECステーションのショップ情報に登録します。

場所:RMS > 拡張サービス一覧 > WEB APIサービス

どのAPIが必要か?

楽天市場のAPIが全部で100種以上のAPIが用意されていますがECステーションツールで必要なAPIは以下になります。
APIを「利用」にしておくことで利用ができます。(ライセンスキーは共通ですがどのAPIを使うかは個々に利用設定をRMSでしておく必要があります)

楽天ペイ受注API
利用するAPI名:楽天ペイ受注API「rpay.order.getOrder
 
これが必要なサービス: 
・即返信Reメール(送信先メアド取得に使用します)
・自動フォローメール(送信先メアド取得に使用します)*楽天RMSから出荷メールを送信している場合
・チラシクリエイター(宛名検索に使用します)
 ※rpay.order.getOrderに加えて『rpay.order.searchOrder』も必要です。
商品API
利用するAPI名:商品API「item.update
 
これが必要なサービス:
・ページクリエイター(商品ページ作成)
※カスタムページ、メルマガでは不要、商品ページをAPIで更新する場合のみ
※商品APIの利用にはRMSにて「商品一括登録(10,000円/月)」へのお申込みが必要
クーポンAPI
利用するAPI名:クーポンAPI「coupon.get」「coupon.search
 
これが必要なサービス:
・チラシクリエイター(クーポンQR自動作成に使用します)
カテゴリAPI
利用するAPI名:カテゴリAPI「shop.categories.get」「shop.category.get
 
これが必要なサービス:
・お店つくーる(カテゴリ一覧の取得に使用します)
商品API (ItemAPI)
利用するAPI名:商品API (ItemAPI)「item.search

RMSのAPI利用申請画面で『※ご利用には商品一括登録へのお申込みが必要です』となっておりますがitem.searchに関しては不要(無料)となります。

これが必要なサービス:
こちらの検索を使うと販売期間外や倉庫商品も検索できます。
(※ただしこの方法で検索した場合にはおすすめショーケースのカメレオンテンプレートでもお気に入り追加ボタンは出せません。)
・ページクリエイター
・チラシクリエイター
・おすすめショーケース
・スマホでにぎわい君
など楽天商品検索機能のあるサービス

 

使用したいAPIを「利用中」にする手順

  1. 1-2 申込、利用規約確認」からお申込み
    申込み済みの方は「既にお申込いただいています」が表示されています。

  2. 2-1 利用設定 WEB API」の「利用機能編集」ボタンをクリックします。

     
    ※楽天マニュアルにも案内がございます。RMS WEB SERVICEのお申込~ご利用までの手順STEP2

  3. 即返信Reメール、自動フォローメールでは受注APIの中の「order.getOrder」を「選択」します。
    (楽天ペイ移行店舗の場合は楽天ペイ受注APIの中の「rpay.order.getOrder」を「選択」します)
     
    ページクリエイターでは商品APIの中の「item.update」を「選択」します。
     
    チラシクリエイターでは楽天ペイ受注API「rpay.order.getOrder」に加えて「rpay.order.searchOrder」及び、クーポンAPIの「coupon.get」「coupon.search」を「選択」します。
     
    お店つくーるではカテゴリAPI「shop.categories.get」「shop.category.get」を「選択」します。
     

     ※詳細は、RMS WEB SERVICEのお申込~ご利用までの手順STEP3をご覧ください

  4. ページ最下部の「確認する」ボタンをクリックします。
    ※この時点ではまだ完了してませんのでご注意願います。

  5. 再度ページ最下部にあるボタン「登録する」をクリックします。

  6. 発行されたサービスシークレット(serviceSecret)ライセンスキー(licenseKey)をECステーションに登録します。

     
     

参考

RMS 店舗運営NAVI [WEB API] RMS WEB SERVICEのお申込~ご利用までの手順
  
  
  

2. ECステーションへのライセンスキー登録

  1. ECステーションにログイン
     
    場所: ECステーションログイン > ≡メニュー > ショップ情報 > 楽天ショップ

    1.  その他設定タブをクリック

    2. 取得した「serviceSecret」と「licenseKey」を入力
      ※コピー&ペーストの場合、不要な半角スペースなどが入らないようご注意ください
      ※「有効期限」は3ヶ月となりますので次回更新日確認用に入力をお勧めします

    3. APIの種類を選択
      ・即返信Reメール、自動フォローメールでは「受注API」で認証テスト
      ・ページクリエイターでは「商品API」で認証テスト
      ※楽天ペイ移行店舗の場合は楽天ペイ「有効にする」にチェックを入れて受注APIで認証テストをします

    4. 認証テストをクリックし、エラーが出ないことを確認します。
       ※エラーが出た場合は、下記のFAQをご参照ください

    5. 保存をクリックして保存

FAQ:APIの設定をしたが稼働できてないようです。

設定に関しまして、以下を今一度ご確認いただけますようお願い致します。

・APIの申請した際に受注APIの中の「order.getOrder」をきちんと
 選択して登録まで完了できているかご確認願います。

・既に過去に「API利用申請済み」だった場合は
 ライセンスキーが期限切れになっていないかをご確認願います。
 (有効期限は3ヵ月となっております
  更新したらECステーション側も登録更新お願いします)

・APIの設定だけでは稼働できません。
 メールの送受信設定や稼働設定ができているかをご確認願います。

・「状態」が「利用中」でない場合、licenseKeyが利用できなくなります。
 

 

3. ライセンスキーの更新(3ヵ月ごと)

ライセンスキーには有効期限があります。(3ヵ月ごと)有効期限が切れる前にライセンスーをRMSにて更新し、新しいキーをECステーションにも登録してください。
※楽天より「【楽天市場】licenseKeyの有効期限のお知らせ」という件名のメールが有効期限切れの1週間前から届きますのでこのメールが来たら対応をお願い致します。

ライセンスキー更新方法

  1. RMSにログインし以下の場所で更新をします。
     
    RMSメインメニュー > 拡張サービス一覧 > WEB APIサービス >
     2-1. WEB API > 利用情報

  2. 確認をクリックしライセンスキーを新しものに更新します。

    1. 確認をクリック
    2. 新しいライセンスキーを発行をクリック
  3. 新しいキーをECステーションに登録し認証テストをクリックして保存します。
     
    場所: ECステーションログイン > ≡メニュー > ショップ情報 > 楽天ショップ

    ※serviceSecretは同じです。

    1. その他設定をクリック
    2. 新しいライセンスキーを登録
      (有効期限は次回更新日の参考に入力します)
    3. APIの種類を選択
      ・即返信Reメール、自動フォローメールでは「受注API」で認証テスト
      ・ページクリエイターでは「商品API」で認証テスト
    4. 認証テストをクリック
      ※エラーになった場合は少し時間をおいて再度お試しください。(ライセンスキー更新後すぐに有効にならない場合があります)
    5. 保存します
PAGE TOP