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