Using the CData ODBC Driver for Superchat 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 Superchat 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 Superchat 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 Superchat

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.

Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

Authentication

To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

Using API Key Authentication

You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Superchat API key.

Example connection string:

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

Below is the syntax for a DSN:

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

Execute SQL to Superchat

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\Superchat.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM Channels WHERE  = ''")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

After connecting to Superchat in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Superchat 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].