Learn more
 

Ready to get started?

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

 Download Now

Learn more:

Square Icon Square ODBC Driver

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

Access Square Transactions, Items, Subscriptions, etc. through a standard ODBC Driver interface.

In this article

Related articles

Natively Connect to Square Data in PHP


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

Drop the CData ODBC Driver for Square into your LAMP or WAMP stack to build Square-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Square 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.

Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

Establish a Connection

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

$conn = odbc_connect("CData ODBC Square 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 Square 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 Refunds WHERE Type = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC Square Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Refunds WHERE Type = ?"); $success = odbc_execute($query, array('FULL'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Square Source","user","password"); $query = odbc_exec($conn, "SELECT Reason, RefundedMoneyAmount FROM Refunds");

Process Results

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

$conn = odbc_connect("CData ODBC Square data Source","user","password"); $query = odbc_exec($conn, "SELECT Reason, RefundedMoneyAmount FROM Refunds"); while($row = odbc_fetch_array($query)){ echo $row["Reason"] . "\n"; }

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

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