Query Sugar CRM Data Using the OData SDK for PHP

The CData API Server, when paired with the ADO.NET Provider for Sugar CRM, exposes Sugar CRM data (or data from any of 200+ other ADO.NET Providers) as Web services. You can follow the procedure below to work with Sugar CRM data as PHP objects.

Set Up the API Server

Follow the steps below to begin producing secure Sugar CRM OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Sugar CRM

After you deploy the API Server and the ADO.NET Provider for Sugar CRM, provide authentication values and other connection properties needed to connect to Sugar CRM by clicking Settings -> Connections and adding a new connection in the API Server administration console.

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.

You can then choose the Sugar CRM entities you want to allow the API Server access to by clicking Settings -> Resources.

Additionally, configure the API Server for compatibility with the OData SDK for PHP: Click Server -> Settings and in the OData section set Default Version to 2.0.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. You can authenticate as well as encrypt connections with SSL. Access can also be restricted based on IP address; by default, only connections from the local machine are allowed.

For simplicity, we will authenticate to the API Server by setting the authtoken in the URL. This is not enabled by default; you will need to add the following lines to the API Server configuration file, settings.cfg.

The settings.cfg file is located in the data directory. In the .NET edition, the data directory is the app_data folder under the www folder. In the Java edition, the data directory's location depends on the operation system:

• Windows: C:\ProgramData\CData\SugarCRM\
• Unix or Mac OS X: ~/cdata/SugarCRM/

Work with Sugar CRM Entities as PHP Objects

Follow the steps below to use the ODataPHP SDK to create a proxy class that will connect to the Web services exposed by the API Server.

1. Pass the URL to a command like the one below:

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\SugarCRMEntities.php

   The preceding command defines classes from the metadata returned in the response from the OData endpoint, then outputs the class definitions to the specified folder.

   Both the API Server and the OData SDK for PHP support forms and Windows authentication. The API Server uses authtokens to authenticate users authorized to access the OData endpoint. You can supply authtokens in HTTP Basic authentication or append them to the OData URL.

   You can configure authorized users in the Settings -> Users section of the API Server administration console.

2. You can now start accessing Sugar CRM data using an object-oriented interface in PHP. The code below creates a record of the Accounts table and then retrieves the live data, showing the newly created record.

   require_once 'SugarCRMEntities.php'; try{ $svc = new CData(); $accounts = new Accounts(); $accounts->Name = 'Bob'; $svc->AddToAccounts($accounts); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->accounts()->Execute(); foreach($response->Result as $accounts) echo $accounts->Name."
"; } catch (Exception $e) { //catch errors from the API Server echo $e->getError(), "\n"; }