印刷する

ユーザー

users > log_in_check

提供されたアクセス情報やハッシュを使用してユーザーがINTER-STREAMにログインできるかどうかを確認します。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数説明
gousersAPIセクション
dolog_in_checkAPIアクション

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

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

以下のPOST変数は必須です。

1. 標準ログイン

変数説明
login (string) Username ログインID(最大40文字)
password (string) Password パスワード
ignore_concurrency (int) 0|1 ユーザーが既にログインしているかどうかに関わらず、検証を実行するかどうか。

2. 外部認証プロバイダーログイン

変数説明
login (string) "" 空の文字列
password (string) "" 空の文字列
ext_auth (int) 1 外部認証プロバイダを使用したログインであることを示します。
ext_provider (string) auth_provider 認証プロバイダの名前
利用可能な値:"twitter", "facebook", "oauth", "google", "openid"
ext_user_id (string) external_user_id 外部認証プロバイダからのユーザーID
ext_token (string) external_token 【オプション】外部認証プロバイダからのユーザ用トークンを持っている場合はここに入力
ext_secret (string) external_secret 【オプション】外部認証プロバイダからのユーザ用秘密鍵を持っている場合はここに入力
ip (string) IP Address 指定しない場合、検出されたIP(アプリケーションのIP)を使用してログインします。
ignore_concurrency (int) 0|1 ユーザーが既にログインしているかどうかに関わらず、検証を実行するかどうか。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
ok:提供されたIDとパスワードでログインできる場合
id:ユーザーID

{
    "ok": "User can log in",
    "id": "2"
}

ログインIDやパスワードが間違っている場合、またはユーザーが既にアクティブなセッションを開いている場合など、リクエストが失敗した場合のレスポンス

{
	"error": "LOG_IN_ERROR",
	"error_long": "Wrong login or password"
}

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

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

REQUEST_ERROR | Password cannot be blank
パスワードが空欄です。

LOG_IN_ERROR | {Message}
指定された理由により、ユーザーはログインできません。

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

PHPサンプルコード

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

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

// POST変数
$POST_VARS = array(
					"login"		=> "john",
                    "password"	=> "xyz123"
                    );

salt, timestamp, signatureを生成してリクエストを送信します。

// APIベースURLと認証情報の収集
$API_URL = "https://www.interstreamdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; 
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // 公開しないでください

// salt, timestamp, signatureの生成
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));

// key, salt, timestamp, signatureをGET変数に追加
$GET_VARS["timestamp"] = $timestamp; 	// UTCタイムスタンプ
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ;      // APIキーID:これは公開されており、アプリケーションを識別するためにAPIによって使用されます
$GET_VARS["signature"] = $signature;

// リクエストURLを作成します。HTTPクエリを作成するためにPHPの組み込み関数を使用しない場合は、値をURLエンコードすることを忘れないでください。
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); 
// ".../api.php?go=api_subject&do=api_action&etc..."のようにURLを構築

// 新しいcURLリソースを作成して適切なオプションを設定
$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, $REQUEST_URL); 
curl_setopt($ch, CURLOPT_POST, true); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS);
// PHPホストに有効なSSL証明書がない場合は、SSL証明書の検証を無効にする必要があります。これは危険であり、有効な証明書がインストールされるまで一時的に行われるべきです。
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.

// APIにリクエストを送信
$response = curl_exec($ch);

// レスポンス処理
if (!$response) { 
	echo 'API call failed'; 
} 
else
{
	print_r(json_decode($response,true)); 
}