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 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
Division: Shared parameters
1 App ID applicationId String 必須 - Check here
2 Affiliate ID affiliateId String - - Check here
3 Response format format String - json Either JSON or XML
When JSON is specified the callback parameter can also be set in order to use JSONP.
4 Callback function name callback String - - Function name to be used with the JSONP output
(UTF-8 URL encoded string)
Alphanumeric characters, periods, or underscores
5 Choosing output fields elements String - - By default, API response all of the fields. You can change response fields by this parameter.
This parameter's data is separated by comma(,).
For example, following request will response only itemName, itemPrice and itemUrl.
elements=itemName,itemPrice,itemUrl
6 Format version formatVersion int - 1

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1 :
Our API response will be returned in Array format as the followings.
You would need to use notation items[0].item.itemName To access itemName parameter. 

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

In case of formatVersion=2 :
Our API response will be returned in Array format as the followings.
You can use notation items[0].itemName To access itemName parameter. 

{"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>
開発方法