Using the CData ODBC Driver for Short.io in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Short.io from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Short.io as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to Short.io

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Short.io
Description = My Description
Profile = C:\profiles\ShortIo.apip
AuthScheme = APIKey
ProfileSettings = 'APIKey = your_api_key'

Execute SQL to Short.io

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\ShortIo.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Domains WHERE  = ''")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

After connecting to Short.io in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Short.io data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].