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

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

#author("2023-09-14T10:11:01+09:00","","")
#author("2023-10-01T00:05:22+09:00","","")
[[FrontPage]]

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

* API情報 [#q6190828]

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

* 概要 [#jfe13a2c]

食品情報提供APIで登録したデータの操作を行う。本APIは開発用である。~
- コールバック処理を発火させる。
- 登録を取り消す。


** 使用方法 [#c62c913f]

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

** リクエスト [#l9016c71]

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

 リクエスト本体
 {
    'type' : (操作タイプ),
    'ver' : 1,
    'appkey' : (割り当てられたアプリケーションキー),
    'nonce' : (毎回異なる16バイト以上のランダムに生成されたASCII文字列),
    'secret' : (アプリケーションシークレット+nonceのSHA256値),
    'regid' : (結果オブジェクトに含まれていた登録結果ID)
  }

|key|必須|項目|内容|h
|type|必須|タイプ|cbtest=コールバック発火/cancel=登録取消|
|ver|必須|バージョン|固定値 1|
|appkey|必須|アプリケーションキー|アクセスを識別する、割り当てられたアプリケーションキー|
|nonce|必須|ナンス|ランダム文字列。半角英数で構成し、16バイト以上、アクセス毎に異なること|
|secret|必須|認証文字列|アプリケーションシークレット+nonceのSHA256値|
|regid|必須|登録結果ID|結果オブジェクトに含まれていた登録結果ID|

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

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


** レスポンス [#b7e56e30]

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

 {
   'result' : true/false,
   'reason' : (resultがfalseの時: 失敗事由)
 }


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

#html{{
<pre class="brush:xml;">
{
    "result": true,
}</pre>
}}


* 仕様変更履歴 [#t05ebefa]

2023/09/01 作成

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