GetAllGoods. Getting a List of All Products

You can get a list of all products from your JustClick shop by requesting a query to the API service using software methods.

Your system will get an array of products where each element will contain as follows:

• digital product ID in the system (good_id)
• the character identifier of the product (good_name), which is specified and is displayed in the service interface
• product name (good_title), as specified in the shop
• product price (good_sum)
• its type (good_type)

good_type can be:

1. digital,
2. physical
3. and with floating price)

The query is sent by the POST method in the URLencode format to the address: http://username.justclick.io/api/GetAllGoods.

Where username is the login of the user in the system, as well as their domain of the third level in the JustClick service.

Parameters Transferred in the Query

There are no parameters for this function. The only parameter transferred is the query hash, as for all other queries.

How Does It Work?

You call the GetAllGoods API function.

Your system will receive the result of the function performing and an array of products in the result variable. The array will look as follows:

$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] => 
        )

)

The response is coded in JSON format. For more details, see the API Service Responses.

Example in PHP

GetHash Function forms the hash to the transferred data.

CheckHash Function checks the hash to the service response.

// Login to the JustClick system
 $user_rs['user_id'] = 'username';
  // The key for forming a hash. See API section (the link in the right bottom corner of the personal account)
 $user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
 
//Forming the hash to the transmitted data
$send_data['hash'] = GetHash(null, $user_rs);

// Calling the GetAllGoods function and decoding the received data
$resp = json_decode(Send('http://username.justclick.io/api/GetAllGoods', $send_data));

// Checking the service response
if(!CheckHash($resp, $user_rs)){
	echo "Error! The response hash is not true!"; print_r($resp);
	exit;
}

if($resp->error_code == 0){
echo “The list of products:”  ;
print_r($resp->result);
}
else
	echo "Error code:{$resp->error_code} - description: {$resp->error_text}";

// =========== Functions of sending, receiving and processing a response ============

// 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); // outputting the response to the variable

	$res = curl_exec($ch);

	curl_close($ch);
	return $res;
}

// Forming the transferred to the API data hash
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);
}

// Checking the received response hash
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; // the hash is correct
	else
		return false; // the hash is not correct
}