Solicitando un listado de Noticias/Eventos
soporte, ws.webtv, api, news, list
Variables GET específicas para esta solicitud:
Var | Valor | Descripción |
go | news | La sección del API |
do | list | 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=news&do=list&{información requerida}
Los siguientes filtros de lista están disponibles como variables POST.
TIP: Puede utilizar varios filtros simultáneamente.
Var | Valor | Descripción |
fields | (string) "field1,field2,..." | Especifique los campos que se incluirán en el resultado. "*" = todos los campos (valor por defecto). "field1, field2, field2" = conjunto de campos [Recomendado] - separados por coma. Campos disponibles: id, id_user, status, status_moderation, type, title, title_url, description, description_seo, tags, img_legend, img_poster, img_social, img_thumbnail, img_icon, date, date_end, views_page, socialize, allow_comments, notification, notification_link_type, notification_link, map, map_center_lat, map_center_lng, map_zoom, map_type, map_marker_lat, map_marker_lng, id_import, date_lastmod |
Opciones de paginación: | ||
resultsPerPageFilter | (int) n | Número de resultados por página |
current_page | (int) n | El número de la página actual |
paging | (int) 0/1 | Para habilitar/deshabilitar la paginación |
limit | (int) n | Límite de resultados (sólo si resultsPerPageFilter no se ha especificado y paging=0) |
Filtros frecuentemente utilizados: | ||
idUserFilter | (int) ID autor | Lista los Noticias/Eventos del usuario especificado |
statusFilter | (mixed) estado | Lista los Noticias/Eventos cuyo estado es igual al especificado.
Opciones disponibles: 0 (inactivo), 1 (activo), "any" NOTA: Las solicitudes sin firmar sólo incluirán Noticias/Eventos con estado activo. |
sortByFilter | (string) "opción" | Ordena la lista. Opciones disponibles: "date" (primero los últimos - valor por defecto), "title" (título),"views_page","id","random","randomSeed","dateRevUp" (fecha inversa, para próximos eventos), "date2" (fecha inversa). |
typeFilter | (mixed) tipo | Lista Noticias/Eventos del tipo especificado. Opciones disponibles: "any" (cualquiera), 0 (Noticia), 1 (Evento) |
tagsFilter | (string) "tag1,tag2,..." | Lista Noticias/Eventos en función de los tags (separados por coma) |
idFilter | (string) "ID1,ID2,..." | Lista Noticias/Eventos cuyo ID coincide con los especificados (separados por coma). |
Filtros de fecha: | ||
dateStartFilter | (int) estampa de tiempo | Lista Noticias/Eventos cuya fecha es igual o posterior al día de la estampa de tiempo (desde 00:00:00) |
dateStartMaxFilter | (int) estampa de tiempo | Lista Noticias/Eventos cuya fecha es igual o anterior al día de la estampa de tiempo (desde 00:00:00) |
dateEndFilter | (int) estampa de tiempo | [Para Eventos] Lista ítems cuya "fecha de finalización" es igual o anterior al día de la estampa de tiempo (hasta 23:59:59) |
Filtros de Categoría: | ||
categoriesFilter | (int) n | Lista Noticias/Eventos asociados a la Categoría. Especifique un ID de Categoría o -1 para listar Noticias/Eventos "huérfanos" (Noticias/Eventos que no están asociados a una Categoría) |
categoriesFilterStrict | (int) 0/1 | (Depende de la opción anterior) Lista Noticias/Eventos directamente asociados a la Categoría especificada (ignorando cualquier "herencia" de Categorías). |
Filtro de Clip directamente relacionado - Desde WS.WebTV v59 | ||
idClipRelationshipFilter | (int) ID Clip | (Este filtro se utiliza para listar las Noticas/Eventos directamente relacionados con un Clip en particular) ID del Clip. |
Filtros de búsqueda: | ||
search | (string) "término" | Término a buscar |
searchMode | (string) "modo" | La manera como el sistema busca el término suministrado. Opciones disponibles: Modos Estándar (rápidos): Busca coincidencias exactas. "std1" = busca en título + tags. "std2" = busca en título + tags + descripción corta. "std3" (valor por defecto) = busca en título + tags + descripción completa. Modos Palabras (más lento, encuentra más coincidencias): Realiza la búsqueda dividiendo el término en palabras y buscando todas las posibles combinaciones de ellas. "words1" = busca en título + tags. "words2" = busca en título + tags + descripción corta. "words3" = busca en título + tags + descripción completa. |
Otros filtros (Desde WS.WebTV 55) |
||
searchableFilter | (int) 0/1 | Lista Noticias/Eventos cuya propiedad "buscable" coincide con el valor. |
indexableFilter | (int) 0/1 | Lista Noticias/Eventos cuya propiedad "indexable" coincide con el valor. |
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" : "38" , "list_total" : 5, "list" : [{ "datesorthint" : "1427355660" , "id" : "58" , "img_poster" : "http:\/\/...\/public\/common\/images\/_default_event_poster.gif" , "title" : "Company celebration" , "type" : "1" , "type_name" : "event" , "user_alias" : "WebTV" }, { "datesorthint" : "1421622000" , "id" : "33" , "img_poster" : "http:\/\/...\/uploads\/images\/event_33_1405010853_poster.jpg" , "title" : "Live webcast" , "type" : "1" , "type_name" : "event" , "user_alias" : "WebTV" }, { "datesorthint" : "1420109160" , "id" : "57" , "img_poster" : "http:\/\/...\/public\/common\/images\/_default_event_poster.gif" , "title" : "Anual meeting" , "type" : "1" , "type_name" : "event" , "user_alias" : "WebTV" }, { "datesorthint" : "1420022700" , "id" : "56" , "img_poster" : "http:\/\/...\/public\/common\/images\/_default_event_poster.gif" , "title" : "Eastern party" , "type" : "1" , "type_name" : "event" , "user_alias" : "WebTV" }, { "datesorthint" : "1419158700" , "id" : "55" , "img_poster" : "http:\/\/...\/public\/common\/images\/_default_event_poster.gif" , "title" : "Halloween party" , "type" : "1" , "type_name" : "event" , "user_alias" : "WebTV" }] } |
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 News/Events were found:
No se encontraron Noticias/Eventos que listar.
Preparando los datos GET y POST.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | // Las variables GET $GET_VARS = array ( "go" => "news" , "do" => "list" ); // Las variables POST $POST_VARS = array ( "fields" => "id,title,img_poster" , // Incluir los campos id, title e img_poster "paging" => 1, // Permitir paginación "resultsPerPageFilter" => 5, // Devolver 5 resultados por página "current_page" => 1, // Devolver la página 1 "sortByFilter" => "date" , // Ordenar por fecha "typeFilter" => 1, // Listar Eventos solamente "statusFilter" => "any" // Incluir ítems con cualquier estado ); |
Generando salt, timestamp, signature y enviando la solicitud
*** El siguiente bloque de código es común para todas las solicitudes firmadas ***
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | // Recopilando la información del API y URL Base $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.<br> // $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)); } |