Natively Connect to Sugar CRM Data in PHP

Ready to get started?

Download a free trial of the Sugar ODBC Driver to get started:

 Download Now

Learn more:

Sugar Icon Sugar ODBC Driver

The Sugar ODBC Driver is a powerful tool that allows you to connect with live Sugar account data, directly from any applications that support ODBC connectivity.

Access CRM data like you would a database - read, write, and update Leads, Contacts, Opportunities, Accounts, etc. through a standard ODBC Driver interface.

The CData ODBC driver for Sugar CRM enables you to create PHP applications with connectivity to Sugar CRM data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Sugar CRM into your LAMP or WAMP stack to build Sugar CRM-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Sugar CRM data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

Establish a Connection

Open the connection to Sugar CRM by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC SugarCRM Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC SugarCRM Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Accounts WHERE Name = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC SugarCRM Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Accounts WHERE Name = ?"); $success = odbc_execute($query, array('Bob'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC SugarCRM Source","user","password"); $query = odbc_exec($conn, "SELECT Name, AnnualRevenue FROM Accounts");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Sugar CRM data Source","user","password"); $query = odbc_exec($conn, "SELECT Name, AnnualRevenue FROM Accounts"); while($row = odbc_fetch_array($query)){ echo $row["Name"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Sugar CRM data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Accounts WHERE Name = ?"); $success = odbc_execute($query, array('Bob')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Sugar CRM-specific adaptations of the PHP community documentation for all ODBC functions.