Import Real-Time Yotpo Data via ODBC in ColdFusion to Build Applications

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 API Driver for ODBC, you can link your ColdFusion web and mobile applications to operational Yotpo 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 Yotpo data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData API Driver for ODBC 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.

Start by setting the Profile connection property to the location of the Yotpo Profile on disk (e.g. C:\profiles\Yotpo.apip). Next, set the ProfileSettings connection property to the connection string for Yotpo (see below).

Yotpo API Profile Settings

To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuthClient.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to your Yotpo AppKey.
• OAuthClientSecret: Set this to your Yotpo AppSecret.

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 Yotpo 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 Yotpo 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 CDataYotpoODBC 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="YotpoQuery" dataSource="CDataYotpoODBC"> 
             SELECT * FROM ProductBottomLine 
           </cfquery> 
       

   And a CFTable can be used to quickly output the table in HTML:

               
             <cftable  
             query = "YotpoQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
   
             <cfcol header="<b>TotalReview</b>" align="Left" width=2 text="TotalReview"/> 
   
             <cfcol header="<b>AverageScore</b>" align="Left" width=15 text="AverageScore"/> 
   
             ...
   
           </cftable> 
       

   Full code, including the HTML portion is available below:

               
           <html> 
           <head><title>CData Software | Yotpo ProductBottomLine Table Demo </title></head> 
           <body> 
           <cfoutput>#ucase("Yotpo ProductBottomLine Table Demo")#</cfoutput> 
           <cfquery name="YotpoQuery" dataSource="CDataYotpoODBC"> 
   
             SELECT * FROM ProductBottomLine 
   
           </cfquery> 
           <cftable  
             query = "YotpoQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
             <cfcol header="<b>TotalReview</b>" align="Left" width=2 text="TotalReview"/> 
   
             <cfcol header="<b>AverageScore</b>" align="Left" width=15 text="AverageScore"/> 
   
             ...
   
           </cftable> 
           </body> 
   
           </html>  
       

6. Finally, run the code in a browser. It produces a table populated with Yotpo 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 Yotpo and start building Yotpo-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.