ユーザー
users > log_in
ユーザのステータスを「ログイン」に変更して、INTER-STREAMにログインします。
このリクエストは通常、ユーザーがアプリケーションにログインした後に行われます。他の同時ログインを避ける為にINTER-STREAM側でユーザーステータスを適切に設定する必要があります。モバイルアプリを開発しているのであれば、users > log_in_check関数を使用するとシステムにログインせずにユーザーの認証情報を確認する事が可能です。モバイルアプリを使用しながらユーザーがINTER-STREAMへアクセスできるようになります。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
変数 | 値 | 説明 |
---|---|---|
go | users | APIセクション |
do | log_in | APIアクション |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
POST変数
以下のPOST変数は必須です。
1. 標準ログイン
変数 | 値 | 説明 |
---|---|---|
login | (string) Username | ログインID |
password | (string) Password | パスワード |
ip | (string) IP Address | 指定しない場合、検出されたIP(アプリケーションのIP)を使用してログインします。 |
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)を使用してログインします。 |
ソーシャルログインのワークフローについてはこちらをご確認ください。
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok:ユーザーログインした場合はステータスを"11"に変更
・id:ユーザーID
・session_id:INTER-STREAM内のセッションID。アクティブ時にユーザーセッションを再検証するために必要になります。
・session_transfer_url:セッションをアプリからINTER-STREAMに転送したい場合は、ユーザーをこのURLにリダイレクトする必要があります。
これはソーシャルログインを実行した後などに便利です。
注:セッション転送URLに変数"&land=destination_url"を追加することにより、ユーザーをINTER-STREAMの特定のページにリダイレクトさせること事が可能です(リダイレクト先はURLエンコードされている必要があります)。
ランディングページを指定していない場合、ユーザーはINTER-STREAMのホームページへ移動します。
・ext_auth:ユーザーに関連付けられた外部認証プロバイダを含む配列
{ "ok": "User was logged in successfully", "id": "2", "session_id": "a94yvewvn0rv1qb2knmk", "session_transfer_url": "http://...?session=a94yvewvn0rv1qb2knmk", "ext_auth": { "twitter": { "id": "93", "id_user": "2", "ext_provider": "twitter", "ext_user_id": "879df78g87df", "ext_token": "ds687f4g9s8df7g98", "ext_secret": "s45dfg4sdfg64dsfg98" } } }
ログインIDやパスワードが間違っている場合、またはユーザーが既にアクティブなセッションを開いている場合など、リクエストが失敗した場合のレスポンス
{ "error": "LOG_IN_ERROR,USER_ID:2", "error_long": "User is already logged in" }
このリクエストは以下のエラーを返す可能性があります。
・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" ); // POST変数 $POST_VARS = array( "login" => "john", "password" => "xyz123", "ip" => "xxx.xxx.xxx.xxx" );
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)); }