[[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|poo(固定)|string定数|必須|オペレーション&br;poo = PUTオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|IDseed|認証シード|string|必須|認証に使う毎回変わるランダムの文字列|
|IDval|認証ハッシュ値|hash|必須|sha1(アプリケーションシークレット+認証シード)の値|
|IDprivate|プライベートID|string|任意|クライアントサイドのID|
|flag_autoid|フラグ:loginid/passwordの自動生成|string|任意|許可されていればログインIDとパスワードを自動生成する|
|uid|要求ログインID|string|設定による|作成するログインID&br;ログインIDの発行が必須の場合は必ず送出|
|password|要求パスワード|string|設定による|作成するログインパスワード&br;ログインIDの発行が必須の場合は必ず送出|
|Format|json,yaml,xml|string定数|任意|出力フォーマット指定&br;省略時json(またはアプリケーションキー毎に指定のフォーマット)|
|Charset|UTF-8,SJIS,EUC-JP|string定数|任意|出力文字コード指定・省略時UTF8&br;出力フォーマットjson,xml時は常にUTF-8|
認証パラメーターAppKey,IDseed,IDvalについては、[[API認証>API認証#authtype_client]]を参照~
出力指定パラメーターFormat,Charsetについては、[[出力フォーマット]]を参照~
** ログインIDに対する規制 [#j7ba062a]
文字列長: 6文字以上64文字未満 &br;
使用可能文字: 0-9A-Za-z@_-. &br;
** パスワードに対する規制 [#t976b05a]
文字列長: 6文字以上64文字未満 &br;
使用可能文字: 0-9A-Za-z@*+!.&#$|\'%_-`{}=?: &br;
* 返値 [#e86e04c1]
|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|api_rescode|integer|API結果コード|
|api_reason|string|API結果文字列|
|userid|string|作成されたユーザーのモバイルダイエットID&br;プライベートIDが送出された場合で、既存のアカウントがあった場合は、既存のモバイルダイエットID&br;既存のアカウントが複数あった場合には、既存のモバイルダイエットIDを列挙した配列|
|allianceid|string|アカウントの属するアライアンスID&br;複数の場合は配列|
|loginid|string|ログインIDが自動生成された場合、その値|
|password|string|パスワードが自動生成された場合、その値|
** JSONの例 [#i0d756ca]
#html{{
<pre class="brush:xml;">
{
"api_result":true,
"api_rescode":1,
"userid":"U8d387b5452f15b057104ed7c",
"allianceid":"IMD",
"loginid":"qojzpsrhyqdi",
"password":"gmkkcuym"
}
</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>U9544c49952f15b274aa6e92d</userid>
<allianceid>IMD</allianceid>
<loginid>hhbcknlctzvy</loginid>
<password>jkzfzmkj</password>
</response>
</pre>
}}
* サンプル [#z5db7844]
PHPサンプル [[サンプル/PHP/ユーザーAPI/ユーザー作成]] &br;
* バージョン [#o0becc47]
このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|