galleries > list

Tutoriales, documentos técnicos y descargas

API: Referencia

Rev. Nov. 4, 2020

Descripción

Solicitando un listado de Galerías.

Permiso Requerido Para La Credencial

OBTENER [Solicitudes Firmadas + Sin Firmar]

NOTA: Las solicitudes sin firmar sólo incluirán Galerías con estado activo.

Imprimir

Construyendo la Solicitud

URL de la Solicitud y Variables GET

Variables GET específicas para esta solicitud:

Var	Valor	Descripción
go	galleries	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=galleries&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.

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, id_channel, id_news, status, status_moderation, privacy, privacy_access_level, title, title_url, description, description_seo, tags, img_poster, img_social, img_thumbnail, img_icon, date, views_page, socialize, allow_comments, 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 Galerías del usuario especificado
statusFilter	(mixed) *estado*	Lista los Galerías cuyo estado es igual al especificado. Opciones disponibles: 0 (inactivo), 1 (activo), "any" NOTA: Las solicitudes sin firmar sólo incluirán Galerías con estado activo.
sortByFilter	(string) *"opción"*	Ordena la lista. Opciones disponibles: "date" (lates first - defaul), "title" (título),"views_page","id","random","randomSeed", "date2" (fecha inversa)
tagsFilter	(string) *"tag1,tag2,..."*	Lista Galerías en función de los tags (separados por coma)
idFilter	(string) *"ID1,ID2,..."*	Lista Galerías cuyo ID coincide con los especificados (separados por coma).
Filtros de fecha:
dateFilter	(int) *estampa de tiempo*	Lista Galerías cuya fecha coincide con el día de la estampa de tiempo (desde 00:00:00 hasta 23:59:59).
dateStartFilter	(int) *estampa de tiempo*	Lista Galerías cuya fecha es igual o posterior al día de la estampa de tiempo (desde 00:00:00)
dateEndFilter	(int) *estampa de tiempo*	Lista Galerías cuya fecha es igual o anterior al día de la estampa de tiempo (hasta 23:59:59)
Filtros de Categoría:
categoriesFilter	(int) n	Lista Galerías asociados a la Categoría. Especifique un ID de Categoría o -1 para listar Galerías "huérfanos" (Galerías que no están asociados a una Categoría)
categoriesFilterStrict	(int) *0/1*	(Depende de la opción anterior) Lista Galerías directamente asociados a la Categoría especificada (ignorando cualquier "herencia" de Categorías).
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.
Filtros de exclusión de contenido prohibido: (Desde WS.WebTV 3.0.2pf1)
excludeForbiddenContent	(int) *0/1*	Si se desea excluir las Galerías "prohibidas" del listado. "Prohibido" significa que el usuario no está autorizado a acceder. Tenga presente que debe pasar la variable "cvr" también (ver un poco más abajo).
cvr	(string) *"ID1,ID2,..."*	CVR = Restricción de Visionado de Contenido (Content View Restriction ). Esta es una lista de IDs de Galerías (separados por coma) a las que el Usuario no está autorizado a acceder. Todas las Galerías cuyos IDs coincidan con los de la lista serán excluidas del listado cuando excludeForbiddenContent = 1. Si cvr es vacío entonces ninguna Galería será excluida del listado con independencia del valor de excludeForbiddenContent.
Otros filtros (Desde WS.WebTV 55)
searchableFilter	(int) *0/1*	Lista Galerías cuya propiedad "buscable" coincide con el valor.
indexableFilter	(int) *0/1*	Lista Galerías cuya propiedad "indexable" coincide con el valor.

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": "4",
    "list_total": 3,
    "list": [{
        "id": "49",
        "img_poster": "http:\/\/......\/public\/common\/images\/_default_gallery_poster.gif",
        "title": "Gallery 1",
        "user_alias": "WebTV"
    }, {
        "id": "40",
        "img_poster": "http:\/\/......\/uploads\/images\/gallery_40_1409303260_poster.jpg",
        "title": "Gallery 2",
        "user_alias": "WebTV"
    }, {
        "id": "37",
        "img_poster": "http:\/\/......\/uploads\/images\/gallery_37_1382608290_poster.jpg",
        "title": "Gallery 3",
        "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 Galleries were found:
No se encontraron Galerías que listar.

Código de ejemplo en PHP

Preparando los datos GET y POST.

// Las variables GET
$GET_VARS = array( 
                    "go"        => "galleries",
                    "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"  => 3, // Devolver 3 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 ***

// 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.<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)); 
}

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

Soluciones de vídeo online profesionales y económicas

API: Introducción

API: Referencia

API: Referencia

galleries > list

Descripción

Permiso Requerido Para La Credencial

Construyendo la Solicitud

URL de la Solicitud y Variables GET

Variables POST

Ejemplos de Respuesta

Código de ejemplo en PHP