How to Query Yotpo Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Yotpo to query Yotpo data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Yotpo data in MySQL Workbench.

Connect to Yotpo Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Yotpo data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Yotpo from MySQL Workbench

The steps below outline connecting to the virtual Yotpo database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Yotpo data.

Connect to Yotpo through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Yotpo).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Yotpo Data

1. Open the connection you just created (CData SQL Gateway for Yotpo).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Yotpo data, like SELECT * FROM `CData API Sys`.ProductBottomLine;

With access to live Yotpo data from MySQL Workbench, you can easily work with Yotpo, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.