ユーザーAPI/ユーザー確認 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• ユーザーAPI/ユーザー確認 へ行く。

[[FrontPage]]

&size(24){ユーザーAPI/ユーザー確認};

* API情報 [#q6190828]

|~名称|ユーザー確認|
|~APIバージョン|1|
|~認証タイプ|ユーザー認証|
|~URL|https://(APIサーバー名)/services/api/(アクセスコード)/|
|~Method|POST|
|~データ形式|application/x-www-form-urlencoded|

* 概要 [#jfe13a2c]

モバイルダイエットのユーザーアカウントを検証する。


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Bu(固定)|string定数|必須|コマンド&br;Bu = ユーザー認証付きBBAPIを呼び出す|
|Category|URG(固定)|string定数|必須|オペレーションカテゴリー&br;URG = コーポレートアカウントマネージャー|
|Operation|voo(固定)|string定数|必須|オペレーション&br;voo = VALIDATEオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|UserAuth|ユーザー認証タイプ|string|必須|userhashbb|
|uid|モバイルダイエットID|string|uidまたはloginidのいずれか必須|ユーザーのモバイルダイエットID|
|loginid|ログインID|string|uidまたはloginidのいずれか必須|ユーザーのログインID|
|password|パスワードハッシュ値|hash|必須|sha1(アプリケーションシークレット+パスワード) の値|
|Format|json,yaml,xml|string定数|任意|出力フォーマット指定&br;省略時json(またはアプリケーションキー毎に指定のフォーマット)|
|Charset|UTF-8,SJIS,EUC-JP|string定数|任意|出力文字コード指定・省略時UTF8&br;出力フォーマットjson,xml時は常にUTF-8|
認証パラメーターAppKey,UserAuth,uid,passwordについては、[[API認証>API認証#authtype_user]]を参照~
出力指定パラメーターFormat,Charsetについては、[[出力フォーマット]]を参照~

* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|api_rescode|integer|API結果コード|
|api_reason|string|API結果文字列|

** JSONの例 [#i0d756ca]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"api_rescode":1,
	"userid":"U8d387b5452f15b057104ed7c"
}
</pre>
}}

** XMLの例 [#c9857f82]
#html{{
<pre class="brush:xml;">
<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <api_result>1</api_result>
    <api_rescode>1</api_rescode>
    <userid>U8d387b5452f15b057104ed7c</userid>
  </response>
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/ユーザーAPI/ユーザー確認]]

* バージョン [#o0becc47]

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