ユーザー
users > email_check
メールアドレスがユーザー登録に有効かどうかを確認します。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | email_check | APIアクション |
| iq | E-Mail address | 確認するメールアドレス(URLエンコード/最大100文字) |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=email_check&iq={email}&{required information}
POST変数
以下のPOST変数はオプションですが推奨されています。
| 変数 | 値 | 説明 |
|---|---|---|
| stringFiltering | (int) 0|1 | 確認にメールアドレスフィルタリングを使用するかどうか |
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok:メールアドレスが有効な場合
{
"ok": "E-Mail is valid and not registered"
}
メールアドレスが既に登録されている場合など、リクエストが失敗した場合のレスポンス
{
"error": "INVALID_EMAIL",
"error_long": "E-Mail not available"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | E-Mail cannot be blank
メールアドレスが空欄です。
・INVALID_EMAIL | {Message}
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数 $GET_VARS = array( "go" => "users", "do" => "email_check", "iq" => "sample@emaildomain.ext" ); // POST変数 $POST_VARS = array();