Manage Yotpo Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Yotpo seamlessly integrates Yotpo data into database management tools like DBArtisan by enabling you to access Yotpo data as a database. This article shows how to create a JDBC source for Yotpo in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Yotpo Data into DBArtisan Projects

Follow the steps below to register Yotpo data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Yotpo data. Yotpo entities are displayed in the Datasource Explorer.

You can now work with Yotpo data as you work with any other database. See the driver help documentation for more information on the queries supported by the Yotpo API.