API Response Statuses, Codes and Descriptions

Code And Response Messages From The JustClick Service API Table

After each access to the API service functions, your system receives a response in the JSON encoding.

(For how to get it and process it, see the PHP example below.)

In the answer, error_code, error_text and hash fields are returned. Sometimes the result array returns, when it is necessary to return more data:

• error_code is the numerical code of the error message;
• error_text is a text error message;
• hash is a signature to the data to make sure that the response is from our system, and not forged (for how it is formed, see below);
• result is the array with the result data (for example, result-> bill_id is the number of the created order).

The response table will be supplemented, as the API service is developed.

Example in PHP Receiving and Processing the Service Response

// Login to the JustClick system.
$user_rs['user_id'] = 'username'; 

// The key for forming a hash. see "Shop" - "Settings" - "RussianPostService and API" - "Secret key for signing".
$user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; 

//Forming the data array for transferring to the API. 
$send_data = array
( 
'rid[0]' => 
'super', 'lead_name' => 
'Name', 'lead_email' => 
'[email protected]', 'lead_phone' => 
'+788888888', 'lead_city' => 
'City', 'aff' => 
111, 'tag' => 
'this is tag', 'ad' => 
1111, 'doneurl2' => 
'http://yandex.com/', ); 

// Forming the hash to the transmitted data.
$send_data['hash'] = GetHash($send_data, $user_rs); 

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

// Checking the service response.
if(!CheckHash($resp, $user_rs))
{ 
echo "Error! The response hash is not true!"; 
exit; 
} 
if($resp->error_code == 0) 
echo "User added to group {$send_data['rid[0]']}. Service response: {$resp->error_code}"; 
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
}