users > revalidate_session

Tutorials, technical documents and downloads

API: Reference

Description

Revalidating the session of an User.

Requirements

Advanced User Management extension.

Required Credential Permission

MODIFY [Signed Requests Only]

Building the Request

Request URL and GET vars

GET vars specific to this request:

Var	Value	Description
go	users	The API section
do	revalidate_session	The API action
iq	*User ID*	The User ID

Resulting Request URL:
The resulting request URL would be similar to this (don't forget to append the required info: key, timestamp, salt and signature):
https://....../api.php?go=users&do=revalidate_session&iq={user_id}&{required information}

POST vars

The following POST vars are required.

Var	Value	Description
session_id	(string) *Session ID*	The session ID returned by log_in API call.
ip	(string) *IP Address*	When not provided, the WebTV will use the detected IP (the IP of the application) to revalidate the User session.

Response Examples

If the request was successful, you'll receive a response containing:
• ok: If the User session was revalidated successfully.
Example:

{
    "ok": "User session was revalidated successfully"
}

If the request failed (for example, if the session ID does not match), you'll receive a response like the following:

{
    "error": "REVALIDATION_ERROR",
    "error_long": "Session Revalidation Error (Different Session ID): You must log out the User"
}

Possible Error Messages
Besides the general errors, this request can return the following errors:

• REQUEST_ERROR | Session ID cannot be blank

• REQUEST_ERROR | Invalid User ID:
User ID is not numeric or lower than 1.

• REVALIDATION_ERROR | {Message}

PHP Example Code

Preparing GET and POST data.

// The GET vars
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "revalidate_session",
                    "iq"		=> 2
					);

// The POST vars
$POST_VARS = array(
					"session_id"	=> "pda3g6ptkt5mpwr4knyt",
					"ip"			=> "xxx.xxx.xxx.xxx"
                    );

Generating the salt, timestamp, signature and sending the request
*** The following code block is common to all signed requests ***

// Collect the API Base URL and Credential info
$API_URL = "https://www.mywebtvdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; 
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // keep this safe!!!

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

// Generating the validation signature
// - Default method: using base64_encode(hash_hmac(...))
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // comment this line if using the next method
// - Simplified method - available since v60: using md5(). 
//   This method requires the variable $API_SIGNATURE_GENERATION_MODE = 1; in the config/Config.inc.php file.
// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // you must "uncomment" this line when using the simplified method

// Append the timestamp, salt, key and signature to the GET vars
$GET_VARS["timestamp"] = $timestamp; 	// UTC timestamp
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ;      // The API Key ID: This is public and is used by the API to identify the application;
$GET_VARS["signature"] = $signature;

// Create the request URL. Please note that if you do not use PHP buit in function 
// to create the HTTP query then don't forget to URL encode the values
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); 
// The previous will build an URL like .../api.php?go=api_subject&do=api_action&etc...

// Create a new cURL resource and set the appropriate options
$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);
// If your PHP host does not have a valid  SSL certificate, you will need to turn off SSL
// Certificate Verification. This is dangerous (!), and should only be done temporarily
// until a valid certificate has been installed
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.

// Sending the request to the API
$response = curl_exec($ch);

// Processing the response
if (!$response) { 
	echo 'API call failed'; 
} 
else
{
	print_r(json_decode($response,true)); 
}

users > revalidate_session | WS.WebTV API Reference | WebTV Solutions

Professional and affordable online video solutions

API: Introduction

API: Reference

API: Reference