This website will be under maintenance from Friday August 23, 2:00 PM to Monday August 26, 2.00 PM JST. Only this website is impacted. The Rakuten APIs will continue to work. Sorry for the inconvenience. For more details please check our SNS announcement.
Home      ;API一覧     ;楽天レシピカテゴリ一覧API

楽天レシピカテゴリ一覧APIは楽天レシピのカテゴリ一覧を返すAPIです。デベロッパーはカテゴリタイプを指定することでこれらの情報を得ることができます。

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


https://app.rakuten.co.jp/services/api/Recipe/CategoryList/20170426?[parameter]=[value]…

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

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

https://app.rakuten.co.jp/services/api/Recipe/CategoryList/20170426?
        applicationId=[アプリID]&
        categoryType=large

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

入力パラメーター


楽天レシピカテゴリ一覧API 入力パラメータ version:2017-04-26

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 カテゴリタイプ categoryType String - 全て 取得カテゴリ種類
下記のいずれかの文字列が指定可能
large
medium
small
(省略時は全て)

出力パラメーター


楽天レシピカテゴリ一覧API 出力パラメーター version:2017-04-26

ID 大分類 分類 項目名 パラメーター 備考
区分:サービス固有パラメーター
1 全体情報
(全体:<result> ~ </result>)
大カテゴリ 大カテゴリ large "<large>~ </large>"内に、複数の大カテゴリが表示されます。
2 カテゴリID categoryId
3 カテゴリ名 categoryName
4 カテゴリURL categoryUrl httpsではじまるカテゴリURLとなります
5 中カテゴリ 中カテゴリ medium "<medium>~ </medium>"内に、複数の中カテゴリが表示されます。
5 カテゴリID categoryId  
6 カテゴリ名 categoryName
7 カテゴリURL categoryUrl httpsではじまるカテゴリURLとなります
8 親のカテゴリID parentCategoryId 親のカテゴリIDは中、小の場合のみ。
9 小カテゴリ 小カテゴリ small "<small>~ </small>"内に、複数の小カテゴリが表示されます。
10 カテゴリID categoryId  
11 カテゴリ名 categoryName
12 カテゴリURL categoryUrl httpsではじまるカテゴリURLとなります
13 親のカテゴリID parentCategoryId 親のカテゴリIDは中、小の場合のみ。

エラー


エラーはHTTPステータスコードで判別してください。

HTTPステータスコード 内容
400 パラメーターエラー
401 不正なトークンによるエラー
403 許可スコープが十分でない場合
503 APIメンテンス
500 APIトラブル
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>