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

Import Real-Time Square Data in ColdFusion to Build Applications


Use CData ODBC drivers to import and use Square data in ColdFusion.

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST. When ColdFusion is paired with the CData ODBC Driver for Square, you can link your ColdFusion web and mobile applications to operational Square data. This allows for your applications to be more robust and complete. This article details how to use the ODBC driver to create a table populated with Square data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData ODBC Driver for Square and Adobe ColdFusion.

Configuring the Connection

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 process. 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.

Adding a Data Source and Creating a Table

After creating a DSN, follow the steps below to add a new data source, test our connection to it, create a ColdFusion markup file, and, finally, import Square Square data and display it in a table in ColdFusion:

  1. From the ColdFusion administrator interface, choose Data & Services.
  2. Here, click "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our ODBC driver, choose "ODBC Socket", then click the "Add" button.
  3. From the ODBC DSN Dropdown menu select CData Square Sys. Under the Advanced Settings section, leave the Connection String blank. Note that any properties specified in this input field will override the ones specified in the DSN Configuration.
  4. Now, test the connection by pressing the check mark to the left of the CDataSquareODBC data source you just created. When the data source reports an "OK" status, it is ready for use.
  5. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

    The following code queries the data source: 

                
        <cfquery name="SquareQuery" dataSource="CDataSquareODBC"> 
          SELECT * FROM Refunds 
        </cfquery>
    And a CFTable can be used to quickly output the table in HTML: 
                
          <cftable  
          query = "SquareQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 

          <cfcol header="<b>Reason</b>" align="Left" width=2 text="Reason"/> 

          <cfcol header="<b>RefundedMoneyAmount</b>" align="Left" width=15 text="RefundedMoneyAmount"/> 

          ...

        </cftable>
    Full code, including the HTML portion is available below: 
                
        <html> 
        <head><title>CData Software | Square Refunds Table Demo </title></head> 
        <body> 
        <cfoutput>#ucase("Square Refunds Table Demo")#</cfoutput> 
        <cfquery name="SquareQuery" dataSource="CDataSquareODBC"> 

          SELECT * FROM Refunds 

        </cfquery> 
        <cftable  
          query = "SquareQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 
          <cfcol header="<b>Reason</b>" align="Left" width=2 text="Reason"/> 

          <cfcol header="<b>RefundedMoneyAmount</b>" align="Left" width=15 text="RefundedMoneyAmount"/> 

          ...

        </cftable> 
        </body> 

        </html>
  6. Finally, run the code in a browser. It produces a table populated with Square data!

As a note, the CData ODBC Drivers also support parameterized queries using the cfqueryparam element. For example: SELECT * FROM Account WHERE name =

Get Started Today

Download a free, 30-day trial of the CData ODBC Driver for Square and start building Square-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.