1996年から続いているコンビニお菓子情報「お菓子の虜」に掲載されている2500種以上のお菓子を、様々な検索軸で検索します。
基本仕様
プロトコル
REST
レスポンス
XML形式、JSON形式、JSONP形式
リクエストURL
https://sysbird.jp/toriko/api
パラメータ
| パラメータ | 項目名 | 説明 | 必須 |
| apikey | APIキー | “guest”固定 | ○ |
| format | レスポンスの形式 | xml(デフォルト) json jsonp | |
| callback | JSONPの場合のコールバック関数名 | 指定のない場合はcallback |
お菓子の種類マスタ
お菓子の種類一覧を取得します。
パラメータ
| パラメータ | 項目名 | 説明 | 必須 |
| list | マスタ種別 | “type”固定 | ○ |
レスポンス
| フィールド | 説明 |
| okashinotoriko | |
| type | [複数要素] |
| id | お菓子の種類ID |
| name | 名称 |
限定地域マスタ
地域限定お菓子を発売している地域の一覧を取得します。
パラメータ
| パラメータ | 項目名 | 説明 | 必須 |
| list | マスタ種別 | “area”固定 | ○ |
レスポンス
| フィールド | 説明 |
| okashinotoriko | |
| area | [複数要素] |
| id | 限定地域ID |
| name | 名称 |
お菓子メーカ一覧
お菓子の発売元企業の一覧を取得します。
パラメータ
| パラメータ | 項目名 | 説明 | 必須 |
| list | マスタ種別 | “maker”固定 | ○ |
レスポンス
| フィールド | 説明 |
| okashinotoriko | |
| maker | [複数要素] |
| name | 名称 |
お菓子の検索
キーワードや種類でお菓子を検索します。
パラメータ
| パラメータ | 項目名 | 説明 | 必須 |
| id | お菓子ID | 掲載番号で検索 | ※1 |
| type | お菓子の種類ID | 1～5：お菓子の種類ID “99”を指定した場合は限定お菓子を取得 | ※1 |
| year | 掲載年 | 掲載年で検索 1996年以降を4ケタの数字で指定 | ※1 |
| maker | お菓子メーカ | メーカ名で部分一致検索 UTF-8でURLエンコーディング | ※1 |
| keyword | キーワード | お菓子の名称で部分一致検索 UTF-8でURLエンコーディング | ※1 |
| max | 取得数 | 1回のリクエストでの取得する件数 | |
| offset | 検索の開始位置 | 検索結果の何件目から出力するかを指定 | |
| sort | ソート項目 | 検索結果の並び順を指定 お菓子名のふりがな：kana 限定地域：area 掲載日：regist メーカ：maker | |
| order | ソートの順序の指定 | a：古い順 d：新しい順(デフォルト) r:ランダム |
※1 いずれか必須
レスポンス
| フィールド | 説明 |
| okashinotoriko | |
| status | OK：正常 NG：エラー |
| error | エラーメッセージ |
| count | 検索結果の件数 |
| query | リクエスト時の検索条件 |
| item | [複数要素] |
| id | お菓子ID |
| name | お菓子の名称 |
| maker | メーカ |
| kana | ふりがな |
| price | 価格 |
| type | お菓子の種類ID |
| regist | 掲載日 |
| area | 限定地域ID 地域限定お菓子でない場合は空白 |
| url | 掲載URL |
| image | 画像URL |
| comment | コメント |
キーワード”カレー”、取得件数10、ソートの順序ランダムで検索した場合のサンプルレスポンス
利用規約
お菓子の虜 Web API は、菓子好きな個人がお菓子を食べた記録を公開するものです。得られる情報について、誤り、不備、不具合または提供の中断が無いことならびに信頼性、正確性、有用性および完全性について一切の保証をしません。それを理解されたうえで商用、非商用とも無料でご利用いただくことができます。
お菓子の虜 Web API を利用していることをお知らせくださると嬉しいです。