Natively Connect to Smartsheet Data in PHP

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

Getting Started

---

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.

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.

Establish a Connection

Open the connection to Smartsheet by calling the or methods. To close connections, use or .

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

Connections opened with are closed when the script ends. Connections opened with the 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 Smartsheet Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Sheet_Event_Plan_Budget WHERE Assigned = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC Smartsheet Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Sheet_Event_Plan_Budget WHERE Assigned = ?");
$success = odbc_execute($query, array('Ana Trujilo'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC Smartsheet Source","user","password");
$query = odbc_exec($conn, "SELECT TaskName, Progress FROM Sheet_Event_Plan_Budget");
 

Process Results

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

$conn = odbc_connect("CData ODBC Smartsheet data Source","user","password");
$query = odbc_exec($conn, "SELECT TaskName, Progress FROM Sheet_Event_Plan_Budget");
while($row = odbc_fetch_array($query)){
 echo $row["TaskName"] . "\n";
}

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

$conn = odbc_connect("CData ODBC Smartsheet data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Sheet_Event_Plan_Budget WHERE Assigned = ?");
$success = odbc_execute($query, array('Ana Trujilo'));
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 Smartsheet-specific adaptations of the PHP community documentation for all ODBC functions.