FrontPage

データAPI/食品詳細情報取得

※オプションサービスとなります

API情報

名称食品詳細情報取得
APIバージョン2
認証タイプなし
URL
https://(APIサーバー名)/services/api2/(アクセスコード)/detail/json/(オブジェクトID)/
MethodGET
データ更新頻度目安1日

概要

指定されたオブジェクトIDの食品の詳細情報を取得する。

アクセス手順

クエリー

https://(APIサーバー名)/services/api2/(アクセスコード)/detail/json/(オブジェクトID)/
(オブジェクトID) の食品詳細情報を返却する。

クエリー例

https://(APIサーバー名)/services/api2/(アクセスコード)/detail/json/FO30c210f05ca1c173183f3ee8/

レスポンス

レスポンスコードは200を返し、レスポンスはjson形式である。
指定されたオブジェクトIDの詳細情報が存在しない場合、又は食品でない場合は、空のオブジェクトが返される。クエリー書式誤り等の場合はレスポンスコード404が返される。

{
 "foods": [
   {
     "name": 食品名,
     "yomi": 食品名よみ,
     "objectid": オブジェクトID,
     "unit": 分量,
     "stuff_e": カロリー,
     :
     "categorytree": [
       第1階層カテゴリー名,
       第2階層カテゴリー名,
       第3階層カテゴリー名,
     ],
     "shopname": メーカー名,
     "elements": [
       {
         "elementid": 構成食材オブジェクトID,
         "elementunit": 構成食材分量
       },
       :
     ]
   },
   {
     (食品データ)
   },
   :
 ],
}

レスポンス例

{
  "name": "卵焼き(2切れ)",
  "yomi": "たまごやきふたきれ",
  "objectid": "FO9a58f57646c9455b3ecac928",
  "unit": 84.1,
  "stuff_e": 103.8,
  "stuff_p": 6.6,
  "stuff_f": 6.3,
  "stuff_c": 4.3,
  "stuff_fiber": 0,
  "carbo": 4.3,
  "categorytree": [
    "和食",
    "単品",
    "副菜・汁物"
  ],
  "shopname": "",
  "elements": [
    {
      "elementid": "FO6453aaa746d3086833cbb5c2",
      "elementunit": 50
    },
    {
      "elementid": "FO90d07a4646d307d4789e8d73",
      "elementunit": 4
    },
    {
      "elementid": "FOb668820346d308702d4cabbd",
      "elementunit": 2
    }
  ]
}

考慮事項

本APIの返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることで更に効率化されると考えられる。

バージョン

このドキュメントのバージョン情報

Version1
Revision1
Editorwest

トップ   リロード   一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2021-02-12 (金) 15:09:23 (95d)