clips > get_xtokenized_url

Tutoriales, documentos técnicos y descargas

API: Referencia

Descripción

Solicitando la URL con token a partir de una URL de un medio, sin token.

NOTA: El token se generará utilizando la información del generador de token externo suministrada en la configuración de la WebTV [+info].

Requerimientos

Extensión StreamClip.

Permiso Requerido Para La Credencial

OBTENER [Solicitudes Firmadas Únicamente]

Imprimir

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_xtokenized_url	La acción del API
iq	*URL*	URL que requiere el token (codificada con URL Encode)

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_xtokenized_url&iq={url}&{información requerida}

Variables POST

La siguientes variables POST son requeridas.

Var	Valor	Descripción
id_clip	(int) *ID Clip*	La ID del Clip al cual está asociado el medio
id_user	(int) *ID Usuario*	La ID del usuario que tiene una sesión activa en la WebTV

La siguiente variable POST es opcional (pero recomendada).

Var	Valor	Descripción
ip	(string) *Dirección IP*	La IP (pública) del Usuario que reproducirá el medio. Si no la suministra, el sistema utilizará la IP detectada (la IP de la aplicación la cual puede -o puede que no- coincida con la IP del Usuario que reproducirá el medio).

Ejemplos de Respuesta

Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• original_url: La URL original.
• tokenized_url: La URL con el token.
• used_ip: La IP utilizada para generar la firma.
Ejemplo:

{
    "original_url": "http:\/\/...urltotokenize...",
    "tokenized_url": "http:\/\/...urltotokenize...?token=xds56f4sadf86asdf87asdf4asd53",
    "used_ip": "xxx.xxx.xxx.xxx"
}

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
Consulte los errores generales.

Ejemplo de Código en PHP

Preparando los datos GET y POST.

// Las variables GET
$GET_VARS = array( 
					"go"        => "clips",
					"do"        => "get_xtokenized_url",
					"iq"        => "http://...urltosign..."
					);

// Las variables POST
$POST_VARS = array(
					"id_clip"	=> 551,
                    "id_user"	=> 3,
                    "ip"		=> "xxx.xxx.xxx"
                    );

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_xtokenized_url | Referencia API WS.WebTV | WebTV Solutions

Soluciones de vídeo online profesionales y económicas

API: Introducción

API: Referencia

API: Referencia