GetCountSubscribe. Obtener el número de contactos de la tienda / grupo

Puede obtener el número de contactos de su cuenta, o del grupo en particular, solicitando una consulta al servicio de API por métodos de software utilizando su correo electrónico. En respuesta, su sistema recibirá el valor numérico de la cantidad de contactos que se pueden utilizar, por ejemplo, para mostrar en la página del sitio en el formulario: «¡Ya tenemos …!» O «Ya registrado … personas».

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

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

El único campo es el campo de identificador de grupo.

Identificadores reservados:

• único: obtener el número de contactos únicos activos;
• todos: obtenga el número de todos los contactos.

¿Como funciona?

Llamas a la función API GetCountSubscribe.

Su sistema recibirá el número de contactos de la tienda en función del identificador. Si existe el identificador de grupo, el sistema recibirá el número del grupo de contacto seleccionado. También puede utilizar identificadores reservados.

La respuesta está codificada en formato JSON. Para obtener más detalles, consulte las respuestas del servicio 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 la matriz de datos para transferir a la API.
$send_data['group_name'] = "group identifier (you also can specify the reserved ones)";
// Formando el hash a los datos transmitidos.
$send_data['hash'] = GetHash($send_data, $user_rs);

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

// Comprobando 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 "Número de contactos"
;
	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. ============

//  Sending the query to the API service
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); // emitimos la respuesta a una 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
}