![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
バイパスキーAPI/画像認識終了処理
| 名称 | 画像認識終了処理 |
|---|---|
| APIバージョン | 1 |
| 認証タイプ | クライアント認証 |
| URL | https://(APIサーバー名)/services/api/(アクセスコード)/ |
| Method | POST |
| データ形式 | multipart/form-data |
画像認識の終了を宣言し、食事を指定する。
| 引数名 | 値 | 型 | 必須 | 内容 |
| v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
| c | Bu(固定) | string定数 | 必須 | コマンド Bu = ユーザーAPIを呼び出す |
| Category | BY2(固定) | string定数 | 必須 | オペレーションカテゴリー BY2 = バイパスキー |
|Operation|god(固定)|string定数|必須|オペレーション
poo = PUTオペレーション
| AppKey | アプリケーションキー | string | 必須 | アプリケーションキーペアのアプリケーションキー |
| UserAuth | ユーザー認証タイプ | string | 必須 | userbypass2 |
| password | パスワードハッシュ値 | hash | 必須 | cookie値 |
| StructData | アップロードデータ | xml | 必須 | 登録するID |
| Format | json,yaml,xml | string定数 | 任意 | 出力フォーマット指定 省略時json(またはアプリケーションキー毎に指定のフォーマット) |
| Charset | UTF-8,SJIS,EUC-JP | string定数 | 任意 | 出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8 |
認証パラメーターAppKey,UserAuth,uid,passwordについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照
mealタグ: ルートノード mealidタグ: 食事ID [必須] entryidタグ: 画像認識キューエントリーID [必須]
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
| api_rescode | integer | API結果コード |
| api_reason | string | API結果文字列 |
{
"api_result":true,
"api_rescode":1,
}
1 1
PHPサンプル サンプル/PHP/バイパスキーAPI/画像認識終了処理
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
