リクエストAPI/食品情報提供リスト取得 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• リクエストAPI/食品情報提供リスト取得 へ行く。

#author("2023-09-14T10:10:48+09:00","","")
#author("2023-10-01T00:04:40+09:00","","")
[[FrontPage]]

&size(24){リクエストAPI/食品情報提供リスト取得(開発用)};

* API情報 [#q6190828]

|~名称|食品情報提供リスト取得|
|~APIバージョン|2|
|~認証タイプ|アプリケーションキーペア|
|~URL|https://s-auth8.mobadai.jp/requests/api2/(accode)/food/list/|
|~URL|https://(サーバー名)/requests/api2/(accode)/food/list/|
|~Method|POST|

* 概要 [#jfe13a2c]

食品情報提供APIで登録したデータを取得する。本APIは開発用である。


** 使用方法 [#c62c913f]

リクエストボディにJSONデータをセットして送信する。

** リクエスト [#l9016c71]

*** JSONデータ書式 [#o8fa0685]

 リクエスト本体
 {
    'type' : 'list',
    'ver' : 1,
    'appkey' : (割り当てられたアプリケーションキー),
    'nonce' : (毎回異なる16バイト以上のランダムに生成されたASCII文字列),
    'secret' : (アプリケーションシークレット+nonceのSHA256値)
  }

|key|必須|項目|内容|h
|type|必須|タイプ|固定値 list|
|ver|必須|バージョン|固定値 1|
|appkey|必須|アプリケーションキー|アクセスを識別する、割り当てられたアプリケーションキー|
|nonce|必須|ナンス|ランダム文字列。半角英数で構成し、16バイト以上、アクセス毎に異なること|
|secret|必須|認証文字列|アプリケーションシークレット+nonceのSHA256値|


*** リクエスト例 [#i994a280]

#html{{
<pre class="brush:xml;">
{
    &quot;type&quot;: &quot;list&quot;,
    &quot;ver&quot;: 1,
    &quot;appkey&quot;: &quot;f37dX1DZdSAV3s9v&quot;,
    &quot;nonce&quot;: &quot;6b785fce3a643ec4&quot;,
    &quot;secret&quot;: &quot;ef7128c7001e63b1f89e3f9317b173dd567b0fead891e196127eef62c9f1fe19&quot;
}</pre>
}}


** レスポンス [#b7e56e30]

成功時、レスポンスコードは200を返す。
失敗時、レスポンスコードは400を返す。
レスポンスはjson形式である。

 {
   'result' : true/false,
   'reason' : (resultがfalseの時: 失敗事由),
   'objects' : [
      (リクエスト情報オブジェクト),
      (リクエスト情報オブジェクト),
   ]
 }

 リクエスト情報オブジェクト
 {
   'type' : 'reqobject',
   'ver' : 1,
   'regid' : (登録結果ID),
   'input' : (入力した食品リクエストオブジェクト),
   'files' : (食品リクエストオブジェクトに付随するファイルの数)
 }

|key|項目|内容|h
|type|タイプ|固定値 reqobject|
|ver|バージョン|固定値 1|
|regid|登録結果ID|登録されたオブジェクトを識別するID|
|cdate|作成日時|オブジェクトが作成された日時|
|input|食品リクエストオブジェクト|食品情報提供APIで入力されたデータ|
|files|添付ファイル数|食品リクエストオブジェクトに付随して入力したファイルの数|


*** レスポンス例 [#i994a280]

#html{{
<pre class="brush:xml;">
{
    "result": true,
    "registed": [
        {
            "type": "reqobject",
            "ver": 1,
            "regid":"20230819154859-JVyL2OxHIhFcKX7fjOPIpf2UfEv0e7kP4FNgajAyLGxKDlRBf",
            "input": {
               "type" : "food",
               "ver" : 1,
               "name" : "夏野菜のカレーオムそば",
               "maker" : "アイエムデイ食堂",
               "optinfo" : "期間限定メニューです。",
               "callback" : {
                    "type" : "mail",
                    "ver" :1,
                    "mailaddr" : "notif@mobadai.jp"
               },
               "state" : "mystate_1234567890"
            },
            "files": 2,
            "result": true
        }
    ]
}</pre>
}}

* 仕様変更履歴 [#t05ebefa]

2023/09/01 作成

このドキュメントのバージョン情報
|Version|2|
|Revision|1|
|Editor|IMD|