![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
リクエストAPI/食品情報提供リスト取得(開発用)
| 名称 | 食品情報提供リスト取得 |
|---|---|
| APIバージョン | 2 |
| 認証タイプ | アプリケーションキーペア |
| URL | https://(サーバー名)/requests/api2/(accode)/food/list/ |
| Method | POST |
食品情報提供APIで登録したデータを取得する。本APIは開発用である。
リクエストボディにJSONデータをセットして送信する。
リクエスト本体
{
'type' : 'list',
'ver' : 1,
'appkey' : (割り当てられたアプリケーションキー),
'nonce' : (毎回異なる16バイト以上のランダムに生成されたASCII文字列),
'secret' : (アプリケーションシークレット+nonceのSHA256値)
}
| key | 必須 | 項目 | 内容 |
| type | 必須 | タイプ | 固定値 list |
| ver | 必須 | バージョン | 固定値 1 |
| appkey | 必須 | アプリケーションキー | アクセスを識別する、割り当てられたアプリケーションキー |
| nonce | 必須 | ナンス | ランダム文字列。半角英数で構成し、16バイト以上、アクセス毎に異なること |
| secret | 必須 | 認証文字列 | アプリケーションシークレット+nonceのSHA256値 |
{
"type": "list",
"ver": 1,
"appkey": "f37dX1DZdSAV3s9v",
"nonce": "6b785fce3a643ec4",
"secret": "ef7128c7001e63b1f89e3f9317b173dd567b0fead891e196127eef62c9f1fe19"
}
成功時、レスポンスコードは200を返す。 失敗時、レスポンスコードは400を返す。 レスポンスはjson形式である。
{
'result' : true/false,
'reason' : (resultがfalseの時: 失敗事由),
'objects' : [
(リクエスト情報オブジェクト),
(リクエスト情報オブジェクト),
]
}
リクエスト情報オブジェクト
{
'type' : 'reqobject',
'ver' : 1,
'regid' : (登録結果ID),
'input' : (入力した食品リクエストオブジェクト),
'files' : (食品リクエストオブジェクトに付随するファイルの数)
}
| key | 項目 | 内容 |
| type | タイプ | 固定値 reqobject |
| ver | バージョン | 固定値 1 |
| regid | 登録結果ID | 登録されたオブジェクトを識別するID |
| cdate | 作成日時 | オブジェクトが作成された日時 |
| input | 食品リクエストオブジェクト | 食品情報提供APIで入力されたデータ |
| files | 添付ファイル数 | 食品リクエストオブジェクトに付随して入力したファイルの数 |
{
"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
}
]
}
2023/09/01 作成
このドキュメントのバージョン情報
| Version | 2 |
| Revision | 1 |
| Editor | IMD |
