How to connect to Short.io Data from IntelliJ

The CData JDBC Driver for Short.io enables you to access Short.io as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Short.io data in IntelliJ.

Create a JBDC Data Source for Short.io

Follow the steps below to add the driver JAR and define connection properties required to connect to Short.io data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.api.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.api.APIDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:api: and includes connection properties separated with semicolons.

     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 JDBC URL is the following:

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

Edit and Save Short.io Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.