Obtener el último contenido visualizado por los Usuarios.
soporte, ws.webtv, api, users, get_stats_for_content_type
Variables GET específicas para esta solicitud:
Var | Valor | Descripción |
go | users | La sección del API |
do | get_stats_for_content_type | La acción del API |
iq | ID Usuario | ID del Usuario. |
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=get_stats_for_content_type&iq={id_usuario}&{información requerida}
La siguiente variables POST es requerida.
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", "event", "interactivity" (desde WS.WebTV 3.0).. |
La siguiente variable POST es opcional.
Var | Valor | Descripción |
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. |
Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• list: Un arreglo con la lista de información estadística del Usuario, para el tipo de contenido.
Ejemplo: [Estadísticas de un Usuario para el tipo de cotnenido Clip] :
{ "list": [ { "id_clip": "1", "duration": "15", "is_ad": "0", "content_title": "Logo Presentation", "page_views": "22", "last_played_second": "0", "complete_playbacks": "4", "total_playbacks": "27", "total_play_time": "70", "heatmap": "998776622222100" }, { "id_clip": "43", "duration": "9", "is_ad": "0", "content_title": "Channel Bumper", "page_views": "1", "last_played_second": "1", "complete_playbacks": "0", "total_playbacks": "14", "total_play_time": "1", "heatmap": "100000000" }, { "id_clip": "9", "duration": "150", "is_ad": "0", "content_title": "Movie Trailer", "page_views": "2", "last_played_second": "0", "complete_playbacks": "0", "total_playbacks": "8", "total_play_time": "26", "heatmap": "311111111111111111111111000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" }, ... ] }
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 User ID:
El ID del Usuario 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" => "get_stats_for_content_type", "iq" => 3 ); // Las variables POST $POST_VARS = array( "contentType" => "clip" );
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)); }