Top  > API一覧 > 楽天アフィリエイト高料率ショップAPI

楽天アフィリエイト高料率ショップAPIは、楽天市場にてアフィリエイト料率を1.1以上に設定している店舗の情報を取得することが可能なAPIです。

リクエストURL(REST/JSON形式の場合)


https://app.rakuten.co.jp/services/api/HighCommissionShop/List/20131205?format=xml&[parameter]=[value]…
https://app.rakuten.co.jp/services/api/HighCommissionShop/List/20131205?format=json&[parameter]=[value]…

※JSONP形式は、JSON形式で入力パラメーターにcallbackを指定することで出力されます。

たとえば、取得する場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)

https://app.rakuten.co.jp/services/api/HighCommissionShop/List/20131205?
format=xml
&applicationId=[Your applicationId]
&page=1
&hits=30

※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。

入力パラメーター


楽天アフィリエイト高料率ショップAPI(HighCommissionShop) 入力パラメーター version:2013-12-05

ID 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
区分:共通パラメーター
1 アプリID applicationId String 必須 - こちらで確認できます
2 アフィリエイトID affiliateId String - 指定無し こちらで確認できます
3 レスポンス形式 format String - json json か xml を選択することができます。
json を選択した場合、 callback パラメーター指定により jsonp 形式にすることもできます。
4 コールバック関数名 callback String - 指定無し JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
5 出力パラメーター指定 elements String - ALL カンマ区切りで、必要な出力パラメータを指定した場合、
指定された出力パラメータのみを返却します。
(例)elements=reviewCount,reviewAverage
6 出力フォーマットバージョン formatVersion int - 1

出力フォーマットのバージョン指定です。

2 を指定すると、JSONの出力方法が改善され以下のようになります。

formatVersion=1 の場合:
配列データに関して、以下の様にデータが返ります。
したがって、最初の itemName にアクセスするためにitems[0].item.itemNameとたどる必要があります。

{"items": [
    {"item": {
        "itemName": "a",
        "itemPrice": 10
    }},
    {"item": {
        "itemName": "b",
        "itemPrice": 20
    }}
]}

formatVersion=2 の場合:
下記のように、配列中の重複するオブジェクトが省略されます。
最初の itemName にアクセスするためにitems[0].itemNameでアクセスできます。

{"items": [
    {
        "itemName": "a",
        "itemPrice": 10
    },
    {
        "itemName": "b",
        "itemPrice": 20
    }
]}
区分:サービス固有パラメーター
1 1ページあたりの取得件数 hits int - 30 1から30までの整数
2 取得ページ page int - 1 1以上の整数

出力パラメーター


楽天アフィリエイト高料率ショップAPI(HighCommissionShop) 出力パラメーター version:2013-12-05

ID 大分類 小分類 項目名 パラメーター 備考
区分:サービス固有パラメーター
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月現在)

エラー

エラー内容はHTTPステータスコードとレスポンスボディから判断できます。

HTTPステータスコード 意味 レスポンスボディ例 (JSON)
400 パラメーターエラー (必須パラメータ不足)

applicationId を指定しなかった場合

{
    "error": "wrong_parameter",
    "error_description": "specify valid applicationId"
}

keyword が正しい値でなかった時。(半角1文字のみ指定など)

{
    "error": "wrong_parameter",
    "error_description": "keyword parameter is not valid"
}
404 対象のデータが存在しなかった場合
{
    "error": "not_found",
    "error_description": "not found"
}
429 リクエスト過多 (各ユーザ制限値超過)

APIリクエスト数が上限に達した場合のエラーです。しばらく時間を空けてから、ご利用ください。

{
    "error": "too_many_requests",
    "error_description": "number of allowed requests has been exceeded for this API. please try again soon."
}
500 楽天ウェブサービス内のエラー

システムエラー。長時間続くようであれば、こちらよりごお問い合わせください。

{
    "error": "system_error",
    "error_description": "api logic error"
}
503 メンテナンス・リクエスト過多 (全ユーザ制限値超過)

メンテナンス (XXX/XXX にはAPI名が入る)

{
    "error": "service_unavailable",
    "error_description": "XXX/XXX is under maintenance"
}

レスポンスボディの形式は format に従います。

format エラー出力例
json
{
    "error": "wrong_parameter",
    "error_description": "page must be a number"
}
xml
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <error>wrong_parameter</error>
    <error_description>page must be a number</error_description>
</root>

過去のバージョン

本APIの過去のバージョンは下記からご覧いただけます。

楽天アフィリエイト高料率ショップAPI (version:2012-03-13)