ユーザー
users > log_out
ステータスを"12"(ログアウト)に変更して、INTER-STREAMのユーザーセッションを閉じます。
リクエストの構築
リクエストURLとGET変数
リクエスト固有のGET変数
| 変数 | 値 | 説明 |
|---|---|---|
| go | users | APIセクション |
| do | log_out | APIアクション |
| iq | User ID | ユーザーID |
リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。
https://....../api.php?go=users&do=log_out&iq={user_id}&{required information}
POST変数
このリクエストにはPOST変数は必要ありません。
応答例
リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・ok:ユーザーがINTER-STREAMからログアウトした場合、ステータスを"12"に変更
{
"ok": "User was logged out successfully"
}
ログインしていないユーザーをログアウトしようとした場合など、リクエストが失敗した場合のレスポンス
{
"error": "LOG_OUT_ERROR",
"error_long": "Error logging out"
}
このリクエストは以下のエラーを返す可能性があります。
・REQUEST_ERROR | Invalid User ID
ユーザーIDが1未満かもしくは数値ではありません。
・LOG_OUT_ERROR | {Message}
指定された理由により、ユーザーをログアウトさせることができませんでした。
その他のエラー内容に関しては一般的なエラーメッセージを確認してください。
PHPサンプルコード
GETおよびPOSTデータを準備します。
// GET変数
$GET_VARS = array(
"go" => "users",
"do" => "log_out",
"iq" => 3
);
// POST変数
$POST_VARS = array();