ユーザー
users > alias_check
ユーザーの登録にユーザー名が有効かどうかを確認します。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | alias_check | APIアクション |
| iq | Alias | 確認するユーザー名(URLエンコード/最大100文字) |
注:username(ログイン時に使用するユーザーID、ログインID)とalias(マイプロフィールや投稿者欄等に表示されるエイリアス、ユーザー名)の違いに注意してください。
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=alias_check&iq={alias}&{required information}
POST変数
このリクエストにはPOST変数は必要ありません。
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok:指定されたユーザー名が有効な場合
{
"ok": "Alias is valid"
}
ユーザー名が既に登録されている場合など、リクエストが失敗した場合のレスポンス
{
"error": "INVALID_ALIAS",
"error_long": "Alias not available"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Alias cannot be blank
ユーザー名が空欄です。
・INVALID_ALIAS | {Message}
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "users", "do" => "alias_check", "iq" => "admin" ); // POST変数 $POST_VARS = array();