GetAllGroups. Recibir una lista de todos los grupos de contactos de la cuenta

Puede obtener la lista de todos los grupos de contactos de su cuenta solicitando una consulta al servicio API mediante métodos de software utilizando su correo electrónico. En respuesta, su sistema recibirá una matriz. Allí para cada grupo se transferirá un ID de grupo y un nombre de grupo. Los grupos automáticos no se incluirán en esta lista.

La consulta se envía mediante el método POST en formato URLencode a la dirección: https://username.soloclic.com/api/GetAllGroups.

Donde username es el inicio de sesión del usuario en el sistema, así como su dominio de tercer nivel en el servicio SoloClic.

Parámetros transferidos en la consulta

No hay parámetros para esta función. El único parámetro transferido es el hash de la consulta, como para todas las demás consultas.

¿Como funciona?

Llamas a la función API GetAllGroups.

Su sistema recibirá el resultado de la función que se realiza y la matriz con grupos de suscripción en la variable de resultado como respuesta.

La matriz de grupos se verá de la siguiente manera:

$resp->result = Array (

[0] => array (
[rass_name] => ID de grupo 1
[rass_title] => Nombre del grupo 1
)

[1] => array (
[rass_name] => ID de grupo 2
[rass_title] => Nombre del grupo 2
)

[2] => array (
[rass_name] => ID de grupo 3
[rass_title] => Nombre del grupo 3
)
)

La respuesta está codificada en formato JSON. Para obtener más detalles, consulte la Estados, Códigos y Descripciones de respuesta de API.

Ejemplo de cómo obtener una Lista de Grupos de Suscripción en PHP

La función GetHash forma el hash de los datos transferidos.

La función CheckHash comprueba el hash de la respuesta del servicio.

// Inicie sesión en el sistema SoloClic.
 $user_rs['user_id'] = 'username';

// La clave para formar un hash. Consulte la sección API (el enlace en la esquina inferior derecha de la cuenta personal)
 $user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
 
// Formando el hash a los datos transmitidos
$send_data['hash'] = GetHash(null, $user_rs);

// Llamar a GetAllGroups en la función de correo del cliente y decodificar los datos recibidos
$resp = json_decode(Send('https://username.soloclic.com/api/GetAllGroups', $send_data));

// Verificando la respuesta del servicio
if(!CheckHash($resp, $user_rs)){
	echo "¡Error! ¡El hash de respuesta no es cierto!"; print_r($resp);
	exit;
}

if($resp->error_code == 0){
echo "Lista de Grupos";
print_r($resp->result);
}
else
        echo "Código de error: {$resp->;error_code} - descripción: {$resp->;error_text}";

// =========== Funciones de enviar, recibir y procesar una respuesta. ============

// Envío de la consulta al servicio API
function Send($url, $data)
{
	$ch = curl_init();
	curl_setopt($ch, CURLOPT_URL, $url);
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
	curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
	curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // dando salida a la respuesta a la variable.

	$res = curl_exec($ch);

	curl_close($ch);
	return $res;
}

// Formando el hash de datos transferidos a la API.
function GetHash($params, $user_rs) {
	$params = http_build_query($params);
	$user_id = $user_rs['user_id'];
	$secret = $user_rs['user_rps_key'];
	$params = "$params::$user_id::$secret";
	return md5($params);
}

// Comprobando el hash de respuesta recibido.
function CheckHash($resp, $user_rs) {
	$secret = $user_rs['user_rps_key'];
	$code = $resp->;error_code;
	$text = $resp->;error_text;
	$hash = md5("$code::$text::$secret");
	if($hash == $resp->;hash)
		return true; // el hash es correcto
	else
		return false; //  el hash no es correcto
}