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

The Reply.io API uses API Key authentication via the x-api-key request header.

Using API Key Authentication

Your Reply.io API key is required to create a connection. To obtain your API key:

1. Log into your Reply.io account.
2. Click your profile icon and select Settings.
3. Navigate to the API section.
4. Copy your API Key.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Reply.io API key.
• UserEmail (optional): Set this to the email address of the Reply.io user on whose behalf requests are made.

Example connection string:

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

Below is the syntax for a DSN:

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

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

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