#author("2021-05-13T13:31:52+09:00","","")
[[FrontPage]]
&size(24){データAPI/JANCODEマップ検索};
オプション契約となり、ご利用には審査が必要となります。&br;
返却する内容はご契約によりカスタマイズできます。(栄養素やOIDだけなど)
* API情報 [#q6190828]
|~名称|JANCODEマップ検索|
|~APIバージョン|2|
|~認証タイプ|なし|
|~URL|https://(APIサーバー名)/services/api2/(アクセスコード)/jancode/json/(JANCODE)/|
|~Method|GET|
|~データ更新頻度目安|1日|
* 概要 [#jfe13a2c]
JANCODEに対応づけられた食品を返却する。
* アクセス手順 [#ya59d11f]
** クエリー [#l9016c71]
https://(APIサーバー名)/services/api2/(アクセスコード)/jancode/json/(JANCODE)/ &br;
JANCODEは必須項目である。
クエリー (GET) の最大値は 8192 Byte(8KB) とする。
** 入力文字列ルール [#u55567aa]
- 数字は半角を用いる(全角英数字は使用されない)
** クエリー例 [#ea78dac9]
https://(APIサーバー名)/services/api2/(アクセスコード)/jancode/json/4901577073670/
** レスポンス [#b7e56e30]
レスポンスコードは200を返し、レスポンスはjson形式である。&br;
指定されたJANCODEに対応づけられた食品があれば、1件以上の結果が返却される。存在しない場合は長さ0の配列が返される。&br;
※指定JANCODEに複数食品の可能性がある場合は、複数件の結果が返却されます。&br;
クエリー書式誤り等の場合はレスポンスコード404が返される。
{
foods :[
{
"name" : 食品名,
"yomi" : 食品名読み,
"objectid" : オブジェクトID,
"unit" : 分量,
"stuff_e" : エネルギー,
"stuff_p" : たんぱく質,
"stuff_f" : 脂質,
"stuff_c" : 炭水化物,
"..そのほかご契約栄養素" : 栄養素値,
"categorytree" : [
第1階層カテゴリー名,
第2階層カテゴリー名,
第3階層カテゴリー名
],
"subsubattr" : {
"gaishoku" : 外食フラグ 0 or 1,
"kakou" : 加工食品フラグ 0 or 1,
"takeout" : テイクアウトフラグ 0 or 1,
},
"shopname" : メーカー名,
"janscore" : 1,
},
{
(食品データ)
},
:
]
}
返却データの構成は、[[データAPI/食品詳細情報取得]] と同一となる。
// 返却データの構成は、janscore を除き、[[データAPI/食品詳細情報取得]] と同一となる。
// 値janscoreは、JANCODE対応の期待される正確さを表す参考値である。
// |jancore|意味|h
// |3|パッケージ情報に基づき入力されたJANCODE。ほぼ正しいと推定される。|
// |2|レビューされたJANCODE。ほぼ正しいと推定される。|
// |0~1|名称から推測された商品のJANCODE。0から1の間の値を取り、1に近いほど正しいと推定される。|
// |-1|名称から推測された商品のJANCODE。正しいものもあると推定される。|
** レスポンス例 [#i994a280]
#html{{
<pre class="brush:xml;">
{
"foods": [
{
"name": "\u30d5\u30e9\u30f3\u30b9\u30d1\u30f3\u30c1\u30c3\u30d7\u30b9 \u30d9\u30fc\u30b3\u30f3\u30da\u30c3\u30d1\u30fc\u5473(1\u888b38g)(\u304a\u3084\u3064\u30ab\u30f3\u30d1\u30cb\u30fc)",
"yomi": "\u3075\u3089\u3093\u3059\u3071\u3093\u3061\u3063\u3077\u3059\u3079\u30fc\u3053\u3093\u307a\u3063\u3071\u30fc\u3042\u3058\u3072\u3068\u3075\u304f\u308d\u3055\u3093\u3058\u3085\u3046\u306f\u3061\u3050\u3089\u3080\u304a\u3084\u3064\u304b\u3093\u3071\u306b\u30fc",
"objectid": "FO004627c94e530a370bda2089",
"unit": 38,
"stuff_e": 187,
"stuff_p": 4.3,
"stuff_f": 8.4,
"stuff_c": 23.5,
"stuff_na": 361,
"stuff_k": 58.8,
"stuff_ca": 10.7,
"stuff_mg": 10.2,
"stuff_pp": 30.5,
"stuff_fe": 0.6,
"stuff_zn": 0.3,
"stuff_cu": 0.1,
"stuff_mn": 0.2,
"stuff_va6": 0.2,
"stuff_vd": 0,
"stuff_ve1": 1.1,
"stuff_vk": 13.3,
"stuff_vb1": 0,
"stuff_vb2": 0,
"stuff_vb3": 0.5,
"stuff_vb6": 0,
"stuff_vb12": 0,
"stuff_vb9": 12.9,
"stuff_vc": 0,
"stuff_fac1": 1,
"stuff_fiber": 1,
"stuff_fac5": 0.5,
"stuff_fac6": 2.9,
"selen": 11.1,
"chrome": 0.7,
"molybdenum": 7.8,
"iodine": 0.1,
"biotin": 0.9,
"categorytree": [
"\u305d\u306e\u4ed6",
"\u83d3\u5b50\u985e",
"\u30b9\u30ca\u30c3\u30af\u83d3\u5b50"
],
"shopsubattr": {
"gaishoku": 0,
"kakou": 1,
"takeout": 0
},
"shopname": "\u304a\u3084\u3064\u30ab\u30f3\u30d1\u30cb\u30fc",
"janscore": 0.88
}
]
}</pre>
}}
* 特記事項 [#z9b4e92a]
* 考慮事項 [#wa8c2055]
* バージョン [#o0becc47]
このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|