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

Variables POST

La siguientes variables POST son requeridas.

Ejemplos de Respuesta

Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• ok: Si el Usuario fue asociado/disociado a/de la(s) Grupo de Usuarios(s).
Ejemplo:

{
    "ok": "The operation was performed"
}

Si la solicitud no es exitosa (por ejemplo, si el valor de association no es válido), recibirá una respuesta como la siguiente:

{
    "error": "REQUEST_ERROR",
    "error_long": "Invalid association"
}

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 válido.

• NOT_FOUND | User not found:
No se encontró el Usuario con el ID especificado.

• REQUEST_ERROR | User Group IDs is Empty
No se suministró un ID de Grupo.

• REQUEST_ERROR | User Group IDs: not provided or invalid
El/los ID(s) de Grupo no son válidos.

• REQUEST_ERROR | Invalid association [Must be 'associate' or 'dissociate']
El valor del campo association no es igual a "associate" o "dissociate" (o no se suministró la información).

• ERRORS_OCCURRED | Some operations succeeded and others failed
Se suministraron varios IDs de Grupo. Algunas operaciones fueron exitosas y otras no (probablemente debido a un ID de Grupo inválido).

• ERROR | The operation(s) failed
La operación falló.

Ejemplo de Código en PHP

Preparando los datos GET y POST.

// The GET vars
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "set_user_group_association",
					"iq"        => 700
					);

// The POST vars
$POST_VARS = array(
                    "inclusion"		=> "associate",
                    "user_group_ids"	=> "1,2"
                    );

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