Connect to Short.io Data in NetBeans
The CData JDBC Driver for Short.io integrates connectivity to live Short.io data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Short.io data in NetBeans. You will create a connection and load Short.io data in the Table Editor.
Create a JDBC Data Source for Short.io in NetBeans
To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:
- Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.api.jar file. The driver JAR is located in the lib subfolder of the installation directory.
- Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.api.APIDriver from the menu.
- Name: Enter the name for the driver.
Define Connection Parameters
Follow the steps below to define required connection properties:
In the Service window, right-click the Database node and click New Connection.
In the New Connection Wizard, enter the following connection properties:
- Driver Name: In the menu, select the CData JDBC Driver for Short.io.
- User Name: Enter the username. This can also be defined in the JDBC URL.
- Password: Enter the password. This can also be defined in the JDBC URL.
JDBC URL: Specify the JDBC URL.
Using API Key Authentication
Short.io uses API Key authentication. To obtain your API key:
- Log in to your Short.io account
- Navigate to Settings > Integrations & API > API
- 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';
Query Short.io Data
To connect to Short.io data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.
To load a table in the Data Views window, right-click the table and then click View Data..