ユーザー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|Bn(固定)|string定数|必須|コマンド&br;Bn = BBAPIを呼び出す|
|Category|URG(固定)|string定数|必須|オペレーションカテゴリー&br;URG = コーポレートアカウントマネージャー|
|Operation|rst(固定)|string定数|必須|オペレーション&br;rak = RESETAUTHKEYオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|IDseed|認証シード|string|必須|認証に使う毎回変わるランダムの文字列|
|IDval|認証ハッシュ値|hash|必須|sha1(アプリケーションシークレット+認証シード)の値|
|uid|モバイルダイエットID|string|uidまたはloginidのいずれか必須|ユーザーのモバイルダイエットID|
|loginid|ログインID|string|uidまたはloginidのいずれか必須|ユーザーのログインID|
|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結果文字列|
|password|string|リセット後の新しいパスワード|

** JSONの例 [#i0d756ca]
#html{{
<pre class="brush:xml;">

{
	"api_result":true,
	"api_rescode":1,
	"password":"hzmayrlp"
}
</pre>
}}

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

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/ユーザーAPI/ユーザーパスワードリセット]]

* 考慮事項 [#n77d1fb7]

本APIはユーザー認証を行わずパスワードをリセットするため、セキュリティを考慮して使用すべきである。~
ユーザーの操作するクライアントから本機能を実行すべきではない。~
本機能は、サーバー側の設定によってアプリーションキー毎に使用を許可するか設定する。充分なセキュリティの考慮がなされているものにのみ許可するべきである。

* バージョン [#o0becc47]

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