Model Context Protocol (MCP) finally gives AI models a way to access the business data needed to make them really useful at work. CData MCP Servers have the depth and performance to make sure AI has access to all of the answers.
Try them now for free →
Query Smartsheet Data Using the OData SDK for PHP
You can use the API Server and the OData PHP SDK to easily consume Smartsheet entities in PHP by modeling them as objects.
The CData API Server, when paired with the ADO.NET Provider for Smartsheet, exposes Smartsheet data (or data from any of 200+ other ADO.NET Providers) as Web services. You can follow the procedure below to work with Smartsheet data as PHP objects.
About Smartsheet Data Integration
CData provides the easiest way to access and integrate live data from Smartsheet. Customers use CData connectivity to:
- Read and write attachments, columns, comments and discussions.
- View the data in individuals cells, report on cell history, and more.
- Perform Smartsheet-specific actions like deleting or downloading attachments, creating, copying, deleting, or moving sheets, and moving or copying rows to another sheet.
Users frequently integrate Smartsheet with analytics tools such as Tableau, Crystal Reports, and Excel. Others leverage our tools to replicate Smartsheet data to databases or data warehouses.
Getting Started
Set Up the API Server
Follow the steps below to begin producing secure Smartsheet 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 Smartsheet
After you deploy the API Server and the ADO.NET Provider for Smartsheet, provide authentication values and other connection properties needed to connect to Smartsheet by clicking Settings -> Connections and adding a new connection in the API Server administration console.
Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.
You can then choose the Smartsheet 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.
[Application]
AllowAuthTokenInUrl = true
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\Smartsheet\
- Unix or Mac OS X: ~/cdata/Smartsheet/
Work with Smartsheet 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.
-
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\SmartsheetEntities.phpThe 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.
-
You can now start accessing Smartsheet data using an object-oriented interface in PHP. The code below creates a record of the Sheet_Event_Plan_Budget table and then retrieves the live data, showing the newly created record.
require_once 'SmartsheetEntities.php'; try{ $svc = new CData(); $sheet_event_plan_budget = new Sheet_Event_Plan_Budget(); $sheet_event_plan_budget->Assigned = 'Ana Trujilo'; $svc->AddToSheet_Event_Plan_Budget($sheet_event_plan_budget); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->sheet_event_plan_budget()->Execute(); foreach($response->Result as $sheet_event_plan_budget) echo $sheet_event_plan_budget->TaskName.""; } catch (Exception $e) { //catch errors from the API Server echo $e->getError(), "\n"; }
