users > list | 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=list&{required information}

POST vars

The following list filters are available by using POST vars.
TIP: You can use several filters at the same time.

Response Examples

If the request was successful, you'll receive a response containing:
• list_total_found: The total amount of items found in the WebTV which matched the criteria (for paging purpose).
• list_total: The number of items in the returned list. This will normally match the limit or resultsPerPageFilter values.
• list: The item list.
Example:

{
    "list_total_found": "16",
    "list_total": 5,
    "list": [{
        "alias": "Elisa",
        "email": "elisa@emaildomain.ext",
        "id": "77",
        "login": "elisita",
        "url": "http:\/\/......\/index.php\/portal\/user\/77\/elisita\/"
    }, {
        "alias": "Mari",
        "email": "mari@emaildomain.ext",
        "id": "68",
        "login": "marian",
        "url": "http:\/\/......\/index.php\/portal\/user\/68\/marian\/"
    }, {
        "alias": "Ralph",
        "email": "ralph@emaildomain.ext",
        "id": "33",
        "login": "ralph2000",
        "url": "http:\/\/......\/index.php\/portal\/user\/33\/ralph2000\/"
    }, {
        "alias": "John",
        "email": "john@emaildomain.ext",
        "id": "32",
        "login": "johnny",
        "url": "http:\/\/......\/index.php\/portal\/user\/32\/johnny\/"
    }, {
        "alias": "Allice",
        "email": "allice@emaildomain.ext",
        "id": "31",
        "login": "allice",
        "url": "http:\/\/......\/index.php\/portal\/user\/31\/allice\/"
    }
}

If the request failed (for example, if the Credential does not have permission to GET), you'll receive a response like the following:

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Permission error: GET"
}

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

• REQUEST_ERROR | No Users were found

PHP Example Code

Preparing GET and POST data.

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

// The POST vars
$POST_VARS = array(
					"fields"				=> "id,email,alias,login", 	// Include only id, email, alias and login
					"paging"				=> 1, 			// Allow paging
					"resultsPerPageFilter"	=> 5, 			// Return 5 results per page
					"current_page"			=> 1,			// Return the page No. 1
					"statusFilter"			=> "any"		// Include Users with any status
                    );

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