users > log_in | Referencia API WS.WebTV | WebTV Solutions

Imprimir

Construyendo la Solicitud

URL de la Solicitud y Variables GET

Variables GET específicas para esta solicitud:

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=users&do=log_in&{información requerida}

Variables POST

La siguientes variables POST son requeridas.

Caso 1 - Login estándar:

Caso 2 - Login usando un proveedor de login externo (WS.WebTV 1.8.5+):

Tenemos un documento detallando el flujo de trabajo para realizar un login social aquí:
https://www.webtvsolutions.com/support.php?s=ws_webtv_api_docs&d=users_log_in_social_workflow&lang=es

Ejemplos de Respuesta

Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• ok: Si el Usuario inició la sesión en la WebTV (cambió su estado a 11).
• id: El ID del Usuario.
• session_id: La ID de sesión del Usuario en la WebTV: La necesitará para revalidar la sesión del Usuario mientras esté activa.
• session_transfer_url: (WS.WebTV 1.8.5+) En caso de que desee transferir la sesión desde su App a la WebTV, debe redireccionar al Usuario a esta URL. Esto es útil, por ejemplo, después de realizar un login social.
NOTA: Desde WS.WebTV 1.9 es posible redirigir al usuario a una página específica de la WebTV, añadiendo &land=url_destino a la URL de transferencia de sesión (la URL de destino debe estar codificada - URL encoded); en caso de que no especifique la página de destino, el usuario será redirigido al Home Page de la WebTV.
• ext_auth: (WS.WebTV 1.8.5+) Arreglo con los proveedores de login externo asociados al Usuario en la WebTV.
Ejemplo:

{
    "ok": "User was logged in successfully",
    "id": "2",
    "session_id": "a94yvewvn0rv1qb2knmk",
    "session_transfer_url": "http://...?session=a94yvewvn0rv1qb2knmk",
    "ext_auth": {
        "twitter": {
            "id": "93",
            "id_user": "2",
            "ext_provider": "twitter",
            "ext_user_id": "879df78g87df",
            "ext_token": "ds687f4g9s8df7g98",
            "ext_secret": "s45dfg4sdfg64dsfg98"
        }
    }
}

Si la solicitud no es exitosa (por ejemplo, si el Nombre de Usuario y/o Contraseña son incorrectos o si el Usuario ya tiene una sesión activa), recibirá una respuesta como la siguiente:

{
    "error": "LOG_IN_ERROR,USER_ID:2",
    "error_long": "User is already logged in"
}

Posibles Mensajes de Error
Además de los errores generales, esta solicitud puede devolver los siguientes errores:

• REQUEST_ERROR | Login/Username cannot be blank:
El Nombre de Usuario no puede ser un string vacío.

• REQUEST_ERROR | Password cannot be blank:
No fue posible encontrar un Usuario con el ID suministrado.

• LOG_IN_ERROR | {Mensaje}:
El Usuario no puede iniciar sesión por la razón especificada.

Ejemplo de Código en PHP

Preparando los datos GET y POST.

// Las variables GET
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "log_in"
					);

// Las variables POST
$POST_VARS = array(
					"login"		=> "john",
					"password"	=> "xyz123",
                    "ip"		=> "xxx.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)); 
}