users > get | 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=get&iq={id_usuario}&{información requerida}

Variables POST

Ninguna. No se requiren variables POST para esta solicitud.

Ejemplos de Respuesta

Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• data: La información del Usuario.
Ejemplo:

{
    "data": {
        "access_level": "0",
        "activation_key": "u4o3cv0wz3u1w3r6rjay",
        "address": "",
        "alias": "WebTV",
        "avatar_display": "0",
        "birthdate": "0000-00-00",
        "cms_access": "1",
        "company": "",
        "content_creation_limits":"0",
        "country": "Usa",
        "date_lastmod": "1426093858",
        "email": "sampleemail@domain.ext",
        "gender": "1",
        "general_cvp_expiration": "0",
        "id": "1",
        "id_privilege_set": "1",
        "img_gravatar_url": "",
        "img_icon": "http:\/\/......\/public\/common\/images\/_default_user_icon.gif",
        "img_social": "http:\/\/......\/public\/common\/images\/_default_user_social.gif",
        "img_thumbnail": "http:\/\/......\/public\/common\/images\/_default_user_thumb.gif",
        "last_ip": "xxx.xxx.xxx.xxx",
        "last_ip_update": "1427695411",
        "last_login": "1427695411",
        "login": "admin",
        "max_created_channels":"5",
        "max_created_clips":"[\"100\",\"100\",\"1\",\"100\",\"100\"]",
        "max_created_galleries":"5",
        "max_created_news":"5",
        "max_created_assorted_files":"5",
        "max_video_upload_size":"300",
        "name": "",
        "notes": "",
        "postal_code": "",
        "profile_page_about": "The WebTV Admin....",
        "profile_page_privacy": "0",
        "profile_page_show_country": "1",
        "profile_page_show_social": "1",
        "profile_page_show_web": "1",
        "reg_ip": "xxx.xxx.xxx.xxx",
        "reg_referer": "",
        "reg_timestamp": "0",
        "reg_useragent": "",
        "session_id": "q6mvdcliagb55mrjylzq",
        "session_time": "1427695426",
        "social_page_facebook": "",
        "social_page_flickr": "",
        "social_page_googleplus": "",
        "social_page_linkedin": "",
        "social_page_other": "",
        "social_page_tuenti": "",
        "social_page_twitter": "",
        "social_page_vkontakte": "",
        "status": "1",
        "surname": "",
        "telephone": "",
        "url": "http:\/\/......\/index.php\/portal\/user\/1\/webtv\/",
        "user_groups": [{
			"id": "1",
			"title": "Grupo 1"
		}, {
			"id": "2",
			"title": "Grupo 2"
		}],
        "vat": "",
        "web": "http:\/\/......\/"
    }
}

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
Además de los errores generales, esta solicitud puede devolver los siguientes errores:

• REQUEST_ERROR | Invalid User ID:
El ID del Usuario no es numérico o es menor que 1.

• REQUEST_ERROR | User not found:
No fue posible encontrar un Usuario con el ID suministrado.

Ejemplo de Código en PHP

Preparando los datos GET y POST.

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

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