Connect to Yotpo Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Yotpo into your processes in RapidMiner. This article uses the CData JDBC Driver for Yotpo to transfer Yotpo data to a process in RapidMiner.

Connect to Yotpo in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Yotpo:

1. Add a new database driver for Yotpo: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   
   jdbc:api:
   

4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   
   cdata.jdbc.api.APIDriver
   

   
6. Create a new Yotpo connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Yotpo driver you configured previously.
9. Enter your connection string in the Host box.

   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 connection string is below:

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

10. Enter your username and password if necessary.

You can now use your Yotpo connection with the various RapidMiner operators in your process. To retrieve Yotpo data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Yotpo data.