Skip to content

Instantly share code, notes, and snippets.

@sugarknowledge
Created November 20, 2012 18:10
Show Gist options
  • Save sugarknowledge/4119737 to your computer and use it in GitHub Desktop.
Save sugarknowledge/4119737 to your computer and use it in GitHub Desktop.
PHP Example using cURL with the v4 REST API to create a note with an attachement
<?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;
//create note -----------------------------------------------------------------------------------
$set_entry_parameters = array(
//session id
"session" => $session_id,
//The name of the module
"module_name" => "Notes",
//Record attributes
"name_value_list" => array(
//to update a record, you will nee to pass in a record id as commented below
//array("name" => "id", "value" => "9b170af9-3080-e22b-fbc1-4fea74def88f"),
array("name" => "name", "value" => "Example Note"),
),
);
$set_entry_result = call("set_entry", $set_entry_parameters, $url);
echo "<pre>";
print_r($set_entry_result);
echo "</pre>";
$note_id = $set_entry_result->id;
//create note attachment -----------------------------------------------------------------------------------
$contents = file_get_contents ("/path/to/example_file.php");
$set_note_attachment_parameters = array(
//session id
"session" => $session_id,
//The attachment details
"note" => array(
//The ID of the note containing the attachment.
'id' => $note_id,
//The file name of the attachment.
'filename' => 'example_file.php',
//The binary contents of the file.
'file' => base64_encode($contents),
),
);
$set_note_attachment_result = call("set_note_attachment", $set_note_attachment_parameters, $url);
echo "<pre>";
print_r($set_note_attachment_result);
echo "</pre>";
?>
//set_entry result
stdClass Object
(
[id] => 72508938-db19-3b5c-b7a8-50abc7ec3fdb
[entry_list] => stdClass Object
(
[name] => stdClass Object
(
[name] => name
[value] => Example Note
)
)
)
//set_note_attachment result
stdClass Object
(
[id] => 72508938-db19-3b5c-b7a8-50abc7ec3fdb
)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment