Solicitando un listado de Categorías
soporte, ws.webtv, api, categories, list
Variables GET específicas para esta solicitud:
Var | Valor | Descripción |
go | categories | 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=categories&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 |
includeData | (int) 0|1 | Si se desea incluir los campos de información. Si es 0 sólo se devolverá una lista conteniendo el ID y el estado de las Categorías. |
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. |
Filtros frecuentemente utilizados: |
||
statusFilter | (mixed) estado | Lista Categorías que coinciden con el estado especificado. Opciones disponibles: "any" (valor por defecto), 0 (inactivo), 1 (activo) NOTA: Las solicitudes sin firmar sólo incluirán Categorías con estado activo. |
sortByFilter | (string) "opción" | Ordena la lista. Opciones disponibles: "title" (valor por defecto), "id", "order_title", "order_id" |
parentFilter | (mixed) padre | Lista Categorías a partir del ID de un padre. Especifique "any" para listar todas las Categorías. Especifique el ID (>0) de una Categoría para listar la Categoría especificada con todos sus hijos. |
maxLevel | (int) (1-4) | El nivel máximo de anidamiento a listar (hasta 4). |
Filtros de búsqueda: |
||
search | (string) "término" | Término a buscar. La búsqueda se realizará únicamente en los títulos de las Categorías. |
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 el valore resultsPerPageFilter.
• list: La lista de ítems.
Ejemplo:
{ "list_total_found": 3, "list_total": 3, "list": [{ "breadcrumb": [5], "children": [], "description": "Live events", "description_seo": "Live events", "id": 5, "id_parent": null, "img_icon": "http:\/\/......\/uploads\/images\/category_5_1364385573_icon.jpg", "img_poster": "http:\/\/......\/uploads\/images\/category_5_1364385573_poster.jpg", "img_social": "http:\/\/......\/uploads\/images\/category_5_1364385573_social.jpg", "img_thumbnail": "http:\/\/......\/uploads\/images\/category_5_1364385573_thumb.jpg", "level": 1, "status": "1", "tags": "", "title": "Live!", "title_url": "live!", "title_url_full": "live!", "url": "http:\/\/......\/index.php\/c\/5\/live!\/", "views_page": "102" }, { "breadcrumb": [1], "children": [6], "description": "Latest Movies", "description_seo": "Latest Movies", "id": 1, "id_parent": null, "img_icon": "http:\/\/......\/uploads\/images\/category_1_1364385555_icon.jpg", "img_poster": "http:\/\/......\/uploads\/images\/category_1_1364385555_poster.jpg", "img_social": "http:\/\/......\/uploads\/images\/category_1_1364385555_social.jpg", "img_thumbnail": "http:\/\/......\/uploads\/images\/category_1_1364385555_thumb.jpg", "level": 1, "status": "1", "tags": "", "title": "Movies", "title_url": "movies", "title_url_full": "movies", "url": "http:\/\/......\/index.php\/c\/1\/movies\/", "views_page": "2557" }, { "breadcrumb": ["1", 6], "children": [], "description": "Action Movies", "description_seo": "Action Movies", "id": 6, "id_parent": "1", "img_icon": "http:\/\/......\/uploads\/images\/category_6_1364385648_icon.jpg", "img_poster": "http:\/\/......\/uploads\/images\/category_6_1364385648_poster.jpg", "img_social": "http:\/\/......\/uploads\/images\/category_6_1364385648_social.jpg", "img_thumbnail": "http:\/\/......\/uploads\/images\/category_6_1364385648_thumb.jpg", "level": 2, "status": "1", "tags": "", "title": "Action", "title_url": "action", "title_url_full": "movies-action", "url": "http:\/\/......\/index.php\/c\/6\/movies-action\/", "views_page": "63" }] }
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 Categories were found:
No se encontraron Categorías que listar.
Preparando los datos GET y POST.
// Las variables GET $GET_VARS = array( "go" => "categories", "do" => "list" ); // Las variables POST $POST_VARS = array( "includeData" => 1, // Incluir todos los capos de información "maxLevel" => 4, // Listar todos los niveles "resultsPerPageFilter" => 3, // Devolver 3 resultados por página "current_page" => 1, // Devolver la página 1 "sortByFilter" => "title", // Ordenar por título "statusFilter" => 1 // Incluir sólo Categorías activas );
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)); }