Skip to content

Instantly share code, notes, and snippets.

@sugarknowledge
Created June 27, 2012 03:24
Show Gist options
  • Save sugarknowledge/3001167 to your computer and use it in GitHub Desktop.
Save sugarknowledge/3001167 to your computer and use it in GitHub Desktop.
PHP Example using cURL with the v4 REST API to retrieve account records with get_entries
<?php
$url = "http://{site_url}/service/v4/rest.php";
$username = "admin";
$password = "password";
//function to make cURL request
function call($method, $parameters, $url)
{
ob_start();
$curl_request = curl_init();
curl_setopt($curl_request, CURLOPT_URL, $url);
curl_setopt($curl_request, CURLOPT_POST, 1);
curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
curl_setopt($curl_request, CURLOPT_HEADER, 1);
curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0);
$jsonEncodedData = json_encode($parameters);
$post = array(
"method" => $method,
"input_type" => "JSON",
"response_type" => "JSON",
"rest_data" => $jsonEncodedData
);
curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post);
$result = curl_exec($curl_request);
curl_close($curl_request);
$result = explode("\r\n\r\n", $result, 2);
$response = json_decode($result[1]);
ob_end_flush();
return $response;
}
//login -------------------------------------------------------------------------------------------
$login_parameters = array(
"user_auth"=>array(
"user_name"=>$username,
"password"=>md5($password),
"version"=>"1"
),
"application_name"=>"RestTest",
"name_value_list"=>array(),
);
$login_result = call("login", $login_parameters, $url);
/*
echo "<pre>";
print_r($login_result);
echo "</pre>";
*/
//get session id
$session_id = $login_result->id;
//retrieve records -------------------------------------------------------------------------------
$get_entries_parameters = array(
//session id
'session' => $session_id,
//The name of the module from which to retrieve records
'module_name' => 'Accounts',
//An array of SugarBean IDs
'ids' => array(
'20328809-9d0a-56fc-0e7c-4f7cb6eb1c83',
'328b22a6-d784-66d9-0295-4f7cb59e8cbb',
),
//Optional. The list of fields to be returned in the results
'select_fields' => array(
'name',
'billing_address_state',
'billing_address_country'
),
//A list of link names and the fields to be returned for each link name
'link_name_to_fields_array' => array(
),
);
$get_entries_result = call("get_entries", $get_entries_parameters, $url);
echo "<pre>";
print_r($get_entries_result);
echo "</pre>";
?>
stdClass Object
(
[entry_list] => Array
(
[0] => stdClass Object
(
[id] => 20328809-9d0a-56fc-0e7c-4f7cb6eb1c83
[module_name] => Accounts
[name_value_list] => stdClass Object
(
[name] => stdClass Object
(
[name] => name
[value] => Jungle Systems Inc
)
[billing_address_state] => stdClass Object
(
[name] => billing_address_state
[value] => NY
)
[billing_address_country] => stdClass Object
(
[name] => billing_address_country
[value] => USA
)
)
)
[1] => stdClass Object
(
[id] => 328b22a6-d784-66d9-0295-4f7cb59e8cbb
[module_name] => Accounts
[name_value_list] => stdClass Object
(
[name] => stdClass Object
(
[name] => name
[value] => Riviera Hotels
)
[billing_address_state] => stdClass Object
(
[name] => billing_address_state
[value] => CA
)
[billing_address_country] => stdClass Object
(
[name] => billing_address_country
[value] => USA
)
)
)
)
[relationship_list] => Array
(
)
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment