印刷する

ユーザー

users > username_check

ユーザーの登録にログインIDが有効かどうかを確認します。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gousersAPIセクション
dousername_checkAPIアクション
iqUsername確認するログインID（URLエンコード/最大40文字）

注：username(ログイン時に使用するユーザーID、ログインID)とalias(マイプロフィールや投稿者欄等に表示されるエイリアス、ユーザー名)の違いに注意してください。

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=users&do=username_check&iq={username}&{required information}
POST変数

このリクエストにはPOST変数は必要ありません。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok：指定されたログインIDが有効な場合

{
    "ok": "Login\/Username is valid"
}

ログインIDが既に登録されている場合など、リクエストが失敗した場合のレスポンス

{
	"error": "INVALID_LOGIN",
	"error_long": "Login\/Username not available"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Login/Username cannot be blank
ログインIDが空欄です。

・INVALID_LOGIN | {Message}

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "username_check",
					"iq"        => "admin"
					);

// POST変数
$POST_VARS = array();