clips > get

Tutoriales, documentos técnicos y descargas

API: Referencia

Rev. Ene. 10, 2017

Descripción

Solicitando la información de un Clip o Anuncio

Permiso Requerido Para La Credencial

OBTENER [Solicitudes Firmadas + Sin Firmar]

NOTA: Las solicitudes sin firmar sólo mostrarán información de Clips con estado activo y aprobados. Además, los listados de medios y subtítulos no se incluirán en el resultado.

Imprimir

IMPORTANTE!
Cuando utilice solicitudes firmadas es responsabilidad de la aplicación:
1) Determinar si el Clip puede ser mostrado al Usuario (el API devolverá la información del Clip con independencia de ser restringido o no). La aplicación debe primero verificar si el Usuario tiene permiso para acceder al Clip (utilizando la llada de API users > get_cvr ) y luego decidir qué hacer.
2) Revisar si el Clip está activo o no (el API devolverá la información del Clip con independencia de su estado). Los posibles valores de estado son: 0 (inactivo), 1 (activo), 2 (pendiente de moderación).
3) Las URLs de los medios (archivos de vídeo) pueden contener los prefijos [cfsig] y [xtok]
• Si encuentra el prefijo [cfsig], entonces la URL requierte una firma CloudFront.
     Para obtener la URL firmada (al momento de reproducir) utilice la llamada de API clips > get_aws_signed_url
• Si encuentra el prefijo [xtok], entonces las URL requiere un token Externo.
     Para obtener la URL con token (al momento de reproducir) utilice la llamada de API clips > get_xtokenized_url
4) Si un Clip está a la venta (restringido / o si el usuario no está autorizado para acceder a él y el campo "on_sale" = 1) y el Clip tiene archivo de "trailer" asociado (en los medios), entonces la aplicación debe permitir el acceso al Clip pero reproducir el archivo de "Trailer" correspondiente.
5) Determinar si ofrece al Usuario la opción de descargar los archivos de medios, examinando los valores de los campos: "downloadable_condition", "downloadable" y "downloadable_xfiles"
• downloadable_condition: La condición para ofrece la opción de descarga
     0 = Siempre: Siempre revisa el ajuste "downloadable" (ver a continuación).
     1 = Dependiendo de la compra: Revisar el ajuste "downloadable" sólo si el Clip está en venta y el Usuario tiene permiso para acceder a él; de lo contrario no se debe ofrecer la opción de descarga.
• downloadable (dependiendo del ajuste "downloadable_condition"): Para ofrecer la opción de descarga al Usuario
     0 = No (no ofrecer la opción de descarga).
     1 = Sí, archivos de la WebTV (permitir la descarga de los archivos en la lista de medios).
     2 = Sí, archivos de la WebTV + Otros archivos (como 1 pero también se deben incluir los archivos especificados en el campo "downloadable_xfiles")
     3 = Sí, otros archivos solamente (solamente permitir la descarga de los archivos especificados en el campo "downloadable_xfiles" )
• downloadable_xfiles: Enlaces a otros archivos descargables.
Formato: Una URL por línea. Cada URL puede aparecer en solitario o con una etiqueta. Ejemplo:
     URL "solitaria": http://www.myserver.com/folder/myfile.mp4
     URL con etiqueta (etiqueta + 3 quiones + URL): Etiqueta---http://www.myserver.com/folder/myfile.mp4

Construyendo la Solicitud

URL de la Solicitud y Variables GET

Variables GET específicas para esta solicitud:

Var	Valor	Descripción
go	clips	La sección del API
do	get	La acción del API
iq	*ID Clip*	ID del Clip o Anuncio

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=clips&do=get&iq={id_clip}&{información requerida}

Variables POST

La siguientes variables POST son opcionales.

Var	Valor	Descripción
generateEmbedCode	(int) *0\|1*	Si es 1, se generarán los códigos Embed correspondientes.
embedWidth	(int) *width*	Ancho del código Embed (en pixels)
embedHeight	(int) *height*	Alto del código Embed (en pixels)
embedURLVars	(string) *"&var1=value1..."*	Variables URL del reproductor de vídeo para el código Embed (consulte las posibles variables aquí)

Ejemplos de Respuesta

Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• data: La información del Clip.
• media: La lista de medios (archivos de vídeo) asociados al Clip.
• media_mbr: [WS.WebTV 1.9+] Las URLs Multi-Bitrate asociadas al Clip (Flash/F4M, HTML5/DASH).
• subtitles: La lista de subtítulos del Clip.
• interactivities: [WS.WebTV 1.9+] La lista de Interactividades.
• channels: La lista de Canales donde el Clip está incluido.
• categories: La lista de Categorías a las que está asociado el Clip.
Ejemplo:

{
    "data": {
        "ad_is_channel_mid_roll": "0",
        "ad_is_channel_pre_roll": "0",
        "ad_is_clip_pre_roll": "0",
        "ad_link": "",
        "ad_policy": "0",
        "admin_template": "",
        "allow_comments": "1",
        "aspect": "1.78",
        "clicks": "0",
        "date": "1381911153",
        "date_formatted": "16\/10\/2013 10:12:33 AM",
        "date_lastmod": "1423210557",
        "date_lastmod_formatted": "06\/02\/2015 09:15:57 AM",
        "description": "<p>Clip description<\/p>",
        "description_seo": "Clip description",
        "dislikes": "1",
        "dislikes_formatted": "1",
        "downloadable": "0",
        "downloadable_condition": "0",
        "downloadable_xfiles": "",
        "duration": "8",
        "duration_formatted": "00:08",
        "id": "45",
        "id_imdb": "",
        "id_import": "",
        "id_user": "1",
        "img_icon": "http:\/\/......\/uploads\/images\/clip_45_1390047394_icon.jpg",
        "img_poster": "http:\/\/......\/uploads\/images\/clip_45_1390047394_poster.jpg",
        "img_social": "http:\/\/......\/uploads\/images\/clip_45_1390047394_social.jpg",
        "img_thumbnail": "http:\/\/......\/uploads\/images\/clip_45_1390047394_thumb.jpg",
        "interactivity_randomization": "0",
        "interactivity_spacing": "1",
        "interactivity_start_delay": "1",
        "interactivity_timing": "0",
        "is_3d": "0",
        "is_360": "0",
        "is_ad": "0",
        "is_featured": "1",
        "is_indexable": "1",
        "is_searchable": "1",
        "is_skippable": "1",
        "is_skippable_after": "0",
        "is_visitable": "1",
        "likes": "1",
        "likes_formatted": "1",
        "privacy": "0",
        "privacy_access_level": "99",
        "socialize": "1",
        "sprite_img": "http:\/\/......\/uploads\/images\/clip_45_1390926596_sprite.jpg",
        "sprite_vtt": "http:\/\/......\/uploads\/images\/clip_45_1390926596_sprite.vtt",
        "status": "1",
        "status_moderation": "1",
        "store_on_sale": "0",
        "store_play_trailer": "1",
        "tags": "tag1, tag2, tag3, tag4",
        "title": "This is a sample Clip",
        "title_url": "this-is-a-sample-clip",
        "type": "1",
        "type_name": "streamclip_vod",
        "url": "http:\/\/......\/index.php\/video\/45\/ws-webtv\/",
        "user_alias": "WebTV",
        "user_url": "http:\/\/......\/index.php\/portal\/user\/1\/webtv\/",
        "views": "346",
        "views_complete": "42",
        "views_complete_formatted": "42",
        "views_embed": "7",
        "views_embed_formatted": "7",
        "views_formatted": "346",
        "views_page": "206",
        "views_page_formatted": "206"
    },
    "media": {
        "0": {
            "id": "4843",
            "id_quality": "2",
            "vod_flash": "http:\/\/......\/uploads\/movies\/myvideo-hq.mp4",
            "vod_html5_h264": "http:\/\/......\/uploads\/movies\/myvideo-hq.mp4",
            "vod_html5_webm": "",
            "live_flash": "",
            "live_ios": "",
            "live_rtsp": "",
            "live_ms": "",
            "embed_flash": "",
            "embed_html5": "",
            "vod_flash_trailer": "",
            "vod_html5_h264_trailer": "",
            "vod_html5_webm_trailer": ""
        },
        "1": {
            "id": "4844",
            "id_quality": "3",
            "vod_flash": "http:\/\/......\/uploads\/movies\/myvideo-normal.mp4",
            "vod_html5_h264": "http:\/\/......\/uploads\/movies\/myvideo-normal.mp4",
            "vod_html5_webm": "",
            "live_flash": "",
            "live_ios": "",
            "live_rtsp": "",
            "live_ms": "",
            "embed_flash": "",
            "embed_html5": "",
            "vod_flash_trailer": "",
            "vod_html5_h264_trailer": "",
            "vod_html5_webm_trailer": ""
        },
        "2": {
            "id": "4845",
            "id_quality": "1",
            "vod_flash": "",
            "vod_html5_h264": "",
            "vod_html5_webm": "",
            "live_flash": "",
            "live_ios": "",
            "live_rtsp": "",
            "live_ms": "",
            "embed_flash": "",
            "embed_html5": "",
            "vod_flash_trailer": "http:\/\/......\/uploads\/movies\/myvideo-low.mp4",
            "vod_html5_h264_trailer": "http:\/\/......\/uploads\/movies\/myvideo-low.mp4",
            "vod_html5_webm_trailer": ""
        }
    },
    "media_mbr": {
        "flash": "http://../f4m_manifest.f4m",
        "html5": "http://../dash_manifest.mpd"
    },
    "subtitles": [],
    "interactivities": {
        "settings": {
            "timing": "absolute",
            "start_delay": -1,
            "spacing": -1,
            "randomize": -1
        },
        "list": [
            {
                "clicks": "18",
                "closable": "1",
                "content": "http://pubads.g.doubleclick.net/....&LR_SCHEMA=vast2",
                "contentType": "vast",
                "duration": -1,
                "end": "8",
                "height": "0",
                "id": "141",
                "link": "",
                "relative_position": -1,
                "start": "5",
                "views": "529",
                "width": "0"
            },
            {
                "clicks": "1",
                "closable": "0",
                "content": "Click aquí para más información!",
                "contentType": "text",
                "duration": -1,
                "end": "4",
                "height": "0",
                "id": "142",
                "link": "http://enlace_interactividad/",
                "relative_position": -1,
                "start": "1",
                "views": "381",
                "width": "0"
            }
        ]
    },
    "channels": [{
        "id": "1",
        "title": "Video Channel 1"
    }],
    "categories": [{
        "id": 7,
        "title": "Animation",
        "breadcrumb": [{
            "id": "1",
            "title": "Movies"
        }, {
            "id": 7,
            "title": "Animation"
        }]
    }]
}

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 | Invalid Clip ID:
El ID del Clip no es numérico o es menor que 1.

• REQUEST_ERROR | Clip not found, inactive or restricted:
No fue posible encontrar un Clip con el ID suministrado.

Ejemplo de Código en PHP

Preparando los datos GET y POST.

// Las variables GET
$GET_VARS = array( 
					"go"        => "clips",
					"do"        => "get",
					"iq"        => 45
					);

// Las variables POST
$POST_VARS = array();

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

clips > get | Referencia API WS.WebTV | WebTV Solutions

Soluciones de vídeo online profesionales y económicas

API: Introducción

API: Referencia

API: Referencia

clips > get

Descripción

Permiso Requerido Para La Credencial

Construyendo la Solicitud

URL de la Solicitud y Variables GET

Variables POST

Ejemplos de Respuesta

Ejemplo de Código en PHP