Connect to Short.io Data in RapidMiner

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

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

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

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

   Using API Key Authentication

   Short.io uses API Key authentication. To obtain your API key:

   1. Log in to your Short.io account
   2. Navigate to Settings > Integrations & API > API
   3. Click Create API Key and copy your API key

   After obtaining the API key, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Short.io API key obtained from Settings > Integrations & API > API.

   Example connection string:

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

   Available Tables

   The Short.io profile provides access to the following tables:

   • Domains - Short.io domains associated with the authenticated account
   • Links - Short links for a domain
   • LinkExpand - Expand a short link by domain and path
   • LinksByOriginalUrl - Retrieve multiple short links matching a given original destination URL
   • Folders - Link folders within a specific domain
   • LinkPermissions - Permission records for a specific link within a domain
   • CountryTargeting - Country-based redirect targeting rules for a specific short link
   • RegionTargeting - Region-based redirect targeting rules for a specific short link
   • Regions - List of available regions/states for a given country code
   • DomainStatistics - Aggregated click and traffic statistics for a Short.io domain
   • LinkStatistics - Aggregated click and traffic statistics for a specific Short.io link

   Built-in Connection String Designer

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

10. Enter your username and password if necessary.

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