users > list | Referencia API WS.WebTV | WebTV Solutions

Imprimir

Construyendo la Solicitud

URL de la Solicitud y Variables GET

Variables GET específicas para esta solicitud:

URL Resultante:
La URL de solicitud resultante sería similar a la siguiente (no se olvide de añadir la información requerida key, timestamp, salt and signature):
https://....../api.php?go=users&do=list&{información requerida}

Variables POST

Los siguientes filtros de lista están disponibles como variables POST.
TIP: Puede utilizar varios filtros simultáneamente.

Ejemplos de Respuesta

Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• list_total_found: El número total de ítems encontrados en la WebTV que cumplieron la condición (para paginación).
• list_total: El número de ítems en la lista resultante. Este número normalmente coincidirá con los valores limit o resultsPerPageFilter.
• list: La lista de ítems.
Ejemplo:

{
    "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\/"
    }
}

Si la solicitud no es exitosa (por ejemplo, si la Credencial no tiene permiso OBTENER), recibirá una respuesta como la siguiente:

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

Posibles Mensajes de Error
Además de los errores generales, esta solicitud puede devolver los siguientes errores:

• REQUEST_ERROR | No Users were found
No se encontraron Usuarios que listar.

Código de ejemplo en PHP

Preparando los datos GET y POST.

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

// Las variables POST
$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
                    );

Generando salt, timestamp, signature y enviando la solicitud
*** El siguiente bloque de código es común para todas las solicitudes firmadas ***

// Recopilando la información del API y URL Base
$API_URL = "https://www.midominiowebtv.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; 
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // Mantenga esto en un lugar seguro!!!

// Generando salt y timestamp
$salt = md5(mt_rand());
$timestamp = time();

// Generando la firma de validación
// - Método por defecto: usando base64_encode(hash_hmac(...))
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); 
// comentar esta línea si se utiliza el otro método
// - Método simplificado - disponible desde v60: usando md5(). 
//   Este método requiere que la variable $API_SIGNATURE_GENERATION_MODE = 1; en el archivo config/Config.inc.php.

// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // debe "des-comentar" esta línea si se utiliza el método simplificado

// Añadiendo timestamp, salt, key y signature a las variables GET
$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;

// Creando la URL de la solicitud. Tenga presente que si no utiliza la función interna de PHP 
// para crear la solicitud HTTP entonces no se olvide de codificar los valores con URL Encode
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); 
// Lo anterior construirá una URL del como .../api.php?go=api_subject&do=api_action&etc...

// Creando un recurso cURL con las opciones apropiadas
$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.

// Enviando la solicitud al API
$response = curl_exec($ch);

// Procesando la respuesta
if (!$response) { 
	echo 'Llamada al API falló'; 
} 
else
{
	print_r(json_decode($response,true)); 
}