Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Branch: master
Fetching contributors…

Cannot retrieve contributors at this time

98 lines (75 sloc) 2.994 kB

SugarCRM REST API Wrapper Class

by Asa Kusuma

http://www.asakusuma.com/

License: MIT

Contents

  1. About
  2. Installation
  3. Usage Example
  4. Notes
  5. get_note_attachment() Example
  6. set_note_attachment() Example

1.About

2.Installation

  1. Configure by setting the $rest_url, $username, and $password class variables in the sugar_rest.php class file. The username and password of any SugarCRM user should work. It's recommended that you create a new SugarCRM user account to be exclusively used for authenticating API calls.
  2. Just import the class with require("sugar_rest.php"); and code away!

3.Usage Example

require_once("sugar_rest.php");
$sugar = new Sugar_REST();
$results = $sugar->get("Accounts",array('id','name'));
print_r($results);

See example.php for another example.

4.Notes

  • The is_valid_id() function may need to modify for different versions of SugarCRM.
  • Different versions of SugarCRM have different ID formats.

5.get_note_attachment() Example

This example outputs the contents of a note's attachment, given the note ID. Assumes $note_id contains the ID of the note you wish to modify.

require_once("sugar_rest.php");
$sugar = new Sugar_REST();

$result = $sugar->get_note_attachment($note);
$filename = $result['note_attachment']['filename'];
$file = $result['note_attachment']['file'];


$file = base64_decode($file);
header("Cache-Control: no-cache private");
header("Content-Description: File Transfer");
header('Content-disposition: attachment; filename='.$filename);
header("Content-Type: application/vnd.ms-excel");
header("Content-Transfer-Encoding: binary");
header('Content-Length: '. strlen($file));
echo $file;
exit;

6.get_note_attachment() Example

This example illustrates how to set a note's attachment from an html form. Assumes $note_id contains the ID of the note you wish to modify.

HTML Code

<form method="post" action="example.php" enctype="multipart/form-data">
    <input name="note_file" type="file" />
    <input type="submit" value="Go" />
</form>

PHP Code (example.php)

require_once("sugar_rest.php");
$sugar = new Sugar_REST();
if ($_FILES["note_file"]["error"] > 0) {
    // Error: $_FILES["file"]["error"]
} else if(isset($_FILES['note_file']['tmp_name']) && $_FILES['note_file']['tmp_name']!="") {
    $handle = fopen($_FILES['note_file']['tmp_name'], "rb");
    $filename = $_FILES['note_file']['name'];
    $contents = fread($handle, filesize($_FILES['note_file']['tmp_name']));
    $binary = base64_encode($contents);
    $file_results = $sugar->set_note_attachment($note_id,$binary,$filename);
}
Jump to Line
Something went wrong with that request. Please try again.