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

Print

Building the Request

Request URL and GET vars

GET vars specific to this request:

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=get&iq={user_id}&{required information}

POST vars

None. No POST vars are required for this request.

Response Examples

If the request was successful, you'll receive a response containing:
• data: The User info.
Example:

{
    "data": {
        "access_level": "0",
        "activation_key": "u4o3cv0wz3u1w3r6rjay",
        "address": "",
        "alias": "WebTV",
        "avatar_display": "0",
        "birthdate": "0000-00-00",
        "cms_access": "1",
        "company": "",
        "content_creation_limits":"0",
        "country": "Usa",
        "date_lastmod": "1426093858",
        "email": "sampleemail@domain.ext",
        "gender": "1",
        "general_cvp_expiration": "0",
        "id": "1",
        "id_privilege_set": "1",
        "img_gravatar_url": "",
        "img_icon": "http:\/\/......\/public\/common\/images\/_default_user_icon.gif",
        "img_social": "http:\/\/......\/public\/common\/images\/_default_user_social.gif",
        "img_thumbnail": "http:\/\/......\/public\/common\/images\/_default_user_thumb.gif",
        "last_ip": "xxx.xxx.xxx.xxx",
        "last_ip_update": "1427695411",
        "last_login": "1427695411",
        "login": "admin",
        "max_created_channels":"5",
        "max_created_clips":"[\"100\",\"100\",\"1\",\"100\",\"100\"]",
        "max_created_galleries":"5",
        "max_created_news":"5",
        "max_created_assorted_files":"5",
        "max_video_upload_size":"300",
        "name": "",
        "notes": "",
        "postal_code": "",
        "profile_page_about": "The WebTV Admin....",
        "profile_page_privacy": "0",
        "profile_page_show_country": "1",
        "profile_page_show_social": "1",
        "profile_page_show_web": "1",
        "reg_ip": "xxx.xxx.xxx.xxx",
        "reg_referer": "",
        "reg_timestamp": "0",
        "reg_useragent": "",
        "session_id": "q6mvdcliagb55mrjylzq",
        "session_time": "1427695426",
        "social_page_facebook": "",
        "social_page_flickr": "",
        "social_page_googleplus": "",
        "social_page_linkedin": "",
        "social_page_other": "",
        "social_page_tuenti": "",
        "social_page_twitter": "",
        "social_page_vkontakte": "",
        "status": "1",
        "surname": "",
        "telephone": "",
        "url": "http:\/\/......\/index.php\/portal\/user\/1\/webtv\/",
        "user_groups": [{
			"id": "1",
			"title": "Group 1"
		}, {
			"id": "2",
			"title": "Group 2"
		}],
        "vat": "",
        "web": "http:\/\/......\/"
    }
}

If the request failed (for example, if no signature was provided in the request), you'll receive a response like the following:

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Missing signature"
}

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

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

• REQUEST_ERROR | User not found:

PHP Example Code

Preparing GET and POST data.

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

// The POST vars
$POST_VARS = array();

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)); 
}