Connect to Short.io Data in RazorSQL
The CData JDBC Driver for Short.io enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Short.io using wizards in RazorSQL.
Create a JDBC Data Source for Short.io Data
- Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
- In the Connection Wizard that appears, set the following properties:
- Driver Location: Set this property to the path to the lib subfolder in the installation directory.
- Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
- Username: Enter the username. (This property can also be set in the JDBC URL.)
- Password: Enter the password. (This property can also be set in the JDBC URL.)
JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.
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 and Select Tables
After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.