GetAllGoods. Obtener una Lista de todos los Productos

Puede obtener una lista de todos los productos de su tienda SoloClic solicitando una consulta al servicio API utilizando métodos de software.

Su sistema obtendrá una variedad de productos donde cada elemento contendrá lo siguiente:

• ID de producto digital en el sistema (good_id)
• el identificador de caracteres del producto (good_name), que se especifica y se muestra en la interfaz de servicio
• nombre del producto (good_title), como se especifica en la tienda
• precio del producto (good_sum)
• su tipo (good_type)

good_type puede ser:

1. digital,
2. físico,
3. y con precio flotante

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

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 de API GetAllGoods.

Su sistema recibirá el resultado de la función que se realiza y una serie de productos en la variable de resultado. La matriz se verá de la siguiente manera:

$resp->result = Array
(
    [0] => array
        (
            [good_id] => 12549
            [good_name] => payment
            [good_title] => PAYMENT
            [good_sum] => 3900.00
            [good_type] => 1
        )

    [1] => array
        (
            [good_id] => 13011
            [good_name] => sales
            [good_title] => SALES
            [good_sum] => 2200.00
            [good_type] => 0
        )
    ......

    [14] => array
        (
            [good_id] => 71546
            [good_name] => super_product
            [good_title] => SUPER PRODUCT 3000
            [good_sum] => 900.00
            [good_type] => 
        )

)

Su sistema recibirá el resultado de la función en formato JSON como respuesta. Para obtener más detalles, consulte la Estados, Códigos y Descripciones de respuesta de API.

Ejemplo 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. Ver la sección de 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 la función GetAllGoods y decodificar los datos recibidos
$resp = json_decode(Send('https://username.soloclic.com/api/GetAllGoods', $send_data));

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

if($resp->;error_code == 0)
	echo "Se elimina el pedido. Respuesta de servicio: {$resp->;error_text}";
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
}