Obtener la lista de Usuarios que han visto un contenido, hasta el momento.
soporte, ws.webtv, api, users, list_who_viewed_content
Variables GET específicas para esta solicitud:
Var | Valor | Descripción |
go | users | La sección del API |
do | list_who_viewed_content | La acción del API |
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_who_viewed_content&{información requerida}
Las siguientes variables POST son requeridas.
Var | Valor | Descripción |
contentType | (string) Tipo de Contenido | Posibles valores: "clip", "channel" (válido para canales de vídeo y páginas), "gallery", "news" (válido para noticias y eventos). |
contentID | (int) ID Contenido | ID del Clip, Canal/Página, Noticia/Evento o Galería. |
Las siguientes variables POST son opcionales.
Var | Valor | Descripción |
includeUserData | (int) 0|1 | Si desea obtener información básica del Usuario (login, alias, nombre, apellidos) junto con los resultados. |
getHeatmapURL | (int) 0/1 | [Sólo si contentType = "clip"] Si desea que se incluya la URL de la imagen del mapa de calor. NOTA: Esta variable está disponible desde WS.WebTV 2.2.0.3. |
likeFavoriteFilter | (string) opción | [Sólo si contentType = "clip"] Para restringir la lista a aquellos Usuarios que les ha gustado el contenido o que lo han añadido a los favoritos. Posibles valores: "liked", "favorited", "likedAndFavorited" NOTA: Esta variable está disponible desde WS.WebTV 3.1 (R50) |
Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• list: Un arreglo con la lista de Usuarios que han visto el contenido hasta la fecha (con estadísticas).
Ejemplo [Lista de Usuarios que vieron un Clip en particular]:
{ "list": [ { "id_user": "22", "login": "mark", "alias": "Markus", "name": "Mark", "surname": "Johnson", "total_playbacks": "27", "complete_playbacks": "4", "last_played_second": "15", "duration": "15", "total_play_time": "98", "page_views": "11" }, { "id_user": "39", "login": "david99", "alias": "DavidOn", "name": "David", "surname": "McDonald", "total_playbacks": "19", "complete_playbacks": "2", "last_played_second": "10", "duration": "15", "total_play_time": "50", "page_views": "0" }, (...) ] }
Si la solicitud no es exitosa (por ejemplo, si no suministró una firma con la solicitud), recibirá una respuesta como la siguiente:
{ "error" : "REQUEST_ERROR", "error_long" : "Missing signature" }
Posibles Mensajes de Error
Además de los errores generales, esta solicitud puede devolver los siguientes errores:
• REQUEST_ERROR | Invalid Content ID:
El ID del Contenido no es numérico o es menor que 1.
• REQUEST_ERROR | Invalid Content Type [Must be 'clip', 'channel', 'news' or 'gallery']:
El valor de contentType no es el esperado.
Preparando los datos GET y POST.
// Las variables GET $GET_VARS = array( "go" => "users", "do" => "list_who_viewed_content" ); // Las variables POST $POST_VARS = array( "contentType" => "clip", "contentID" => 2, "includeUserData" => 1 );
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)); }