楽天アフィリエイト高料率ショップAPIは、楽天市場にてアフィリエイト料率を1.1以上に設定している店舗の情報を取得することが可能なAPIです。
リクエストURL（REST／JSON形式の場合）
http://api.rakuten.co.jp/rws/3.0/rest?[parameter]=[value]… http://api.rakuten.co.jp/rws/3.0/json?[parameter]=[value]…
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
たとえば、取得する場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)
http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=HighCommissionShop
&version=2012-03-13
※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。
入力パラメーター
楽天アフィリエイト高料率ショップAPI（HighCommissionShop) 入力パラメーター version:2012-03-13
| ID | 項目名 | パラメーター | 型(括弧内は最大バイト数) | 必須 | デフォルト | 備考 |
|---|---|---|---|---|---|---|
| 区分:共通パラメーター | ||||||
| 1 | デベロッパーID | developerId | String |  |
- | デベロッパーID（こちらで確認できるアプリケーションIDのことです） |
| 2 | アフィリエイトID | affiliateId | String | - | 指定無し | アフィリエイトID |
| 3 | 操作 | operation | String | |
- | 使用するAPIの操作名:HighCommissionShop |
| 4 | コールバック関数名 | callBack | String | - | - | JSONPとして出力する際のコールバック関数名 （UTF-8でURLエンコードした文字列） 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
| 区分:サービス固有パラメーター | ||||||
| 1 | バージョン | version | String | |
- | 2012-03-13 |
| 2 | 1ページあたりの取得件数 | hits | int | - | 30 | 1から30までの整数 |
| 3 | 取得ページ | page | int | - | 1 | 1以上の整数 |
出力パラメーター
楽天アフィリエイト高料率ショップAPI（HighCommissionShop) 出力パラメーター version:2012-03-13
| ID | 大分類 | 小分類 | 項目名 | パラメーター | 備考 |
|---|---|---|---|---|---|
| 区分:共通パラメーター | |||||
| 1 | Arg | - | User-Agent | Valueにはユーザのユーザエージェントが表示される | |
| 2 | - | developerId | ValueにはデベロッパーIDが表示される | ||
| 3 | - | affiliateId | Valueにはユーザの指定したアフィリエイトIDが表示される | ||
| 4 | - | operation | Valueにはユーザの指定した操作名が表示される | ||
| 5 | - | version | Valueにはユーザの指定した操作のバージョンが表示される | ||
| 6 | Status | - | Status | Success / NotFound / ServerError / ClientError / Maintenance のいずれか | |
| 7 | StatusMsg | - | StatusMsg | Statusに特化したメッセージを出力 | |
| 区分:サービス固有パラメーター | |||||
| 1 | 全体情報 | 検索数 | count | 検索結果の総商品数 | |
| 2 | ページ番号 | page | 現在のページ番号 | ||
| 3 | ページ内商品始追番 | first | 検索結果の何件目からか | ||
| 4 | ページ内商品終追番 | last | 検索結果の何件目までか | ||
| 5 | ヒット件数 | hits | 1度に返却する商品数 | ||
| 6 | 総ページ数 | pageCount | |||
| 7 | 料率適用開始日 | startApplyDate | 表示例「YYYY/MM/DD」 | ||
| 8 | 高料率ショップ情報 （全体：<Shops> ～ </Shops> 、 個別：<Shop> ～ </Shop>） |
店舗基本情報 | 店舗名 | shopName | |
| 9 | 店舗コード | shopCode | 店舗ごとのURL （http:// www.rakuten.co.jp/[xyz] におけるxyzのこと |
||
| 10 | 店舗URL | shopUrl | httpからはじまる店舗ごとのURL | ||
| 11 | ジャンル情報 | ジャンルID | genreId | ||
| 12 | ジャンル名 | genreName | |||
| 13 | アフィリエイト情報 | 料率S | affiliateRateS | ||
| 14 | 料率A | affiliateRateA | |||
| 15 | 料率B | affiliateRateB | |||
| 16 | 料率C | affiliateRateC | |||
| 17 | 料率D | affiliateRateD | |||
| 18 | 料率タイプ | commissionType | 1: 通常料率 2: 新料率 * 通常料率・新料率についてはこちらをご覧ください。 |
||
| 19 | アフィリエイトURL | affiliateUrl | （入力パラメーターにアフィリエイトIDが含まれていた時のみ） * carrierパラメーターの指定に関わらずPC/mobile両対応のURLを返却 |
||
アフィリエイトに関して
デベロッパーは、楽天アフィリエイト高料率ショップAPIからアフィリエイトURLを取得することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。
アフィリエイトURLを作るには、APIの入力パラメーターに「アフィリエイトID」を含めてリクエストしてください。APIの出力に「アフィリエイトURL」が含まれます。
入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。（2012年1月現在）
エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 | 内容 |
|---|---|
| NotFound | 検索結果が存在しない。 |
| ServerError | 楽天ウェブサービス側のエラー。 |
| ClientError | デベロッパーの入力に起因するエラー。 |
| Maintenance | メンテナンス。 |