Connect to Reply.io Data in RapidMiner

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

Connect to Reply.io in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Reply.io:

1. Add a new database driver for Reply.io: 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 Reply.io connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Reply.io driver you configured previously.
9. Enter your connection string in the Host box.

   The Reply.io API uses API Key authentication via the x-api-key request header.

   Using API Key Authentication

   Your Reply.io API key is required to create a connection. To obtain your API key:

   1. Log into your Reply.io account.
   2. Click your profile icon and select Settings.
   3. Navigate to the API section.
   4. Copy your API Key.

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Reply.io API key.
   • UserEmail (optional): Set this to the email address of the Reply.io user on whose behalf requests are made.

   Example connection string:

   Profile=C:\profiles\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Reply.io 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\ReplyIO.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

10. Enter your username and password if necessary.

You can now use your Reply.io connection with the various RapidMiner operators in your process. To retrieve Reply.io 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 Reply.io data.