Connect to Yotpo Data in RazorSQL

The CData JDBC Driver for Yotpo enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Yotpo using wizards in RazorSQL.

Create a JDBC Data Source for Yotpo Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Yotpo JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     
     java -jar cdata.jdbc.api.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     

     A typical JDBC URL is the following:

     jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;

Query Yotpo Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.