Learn more
 

Ready to get started?

Connect to live data from Aha with the API Driver

Connect to Aha

In this article

Related articles

Using the CData ODBC Driver for Aha in PyCharm


Connect to Aha as an ODBC data source in PyCharm using the CData ODBC Driver for Aha.

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 Aha 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 Aha 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 Aha

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.

Start by setting the Profile connection property to the location of the Aha! Profile on disk (e.g. C:\profiles\aha.apip). Next, set the ProfileSettings connection property to the connection string for Aha! (see below).

Aha! API Profile Settings

The Aha! API uses OAuth-based authentication.

You will first need to register an OAuth app with Aha!. This can be done from your Aha! account under 'Settings' > 'Personal' > 'Developer' > 'OAuth Applications'. Additionally, you will need to set the Domain, found in the domain name of your Aha account. For example if your Aha account is acmeinc.aha.io, then the Domain should be 'acmeinc'.

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the client_id that is specified in you app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.
  • Domain: Set this in the ProfileSettings to your Aha domain.

Below is the syntax for a DSN:

[CData API Source] Driver = CData ODBC Driver for Aha Description = My Description Profile = C:\profiles\aha.apip ProfileSettings = 'Domain = acmeinc' Authscheme = OAuth OAuthClientId = your_client_id OAuthClientSecret = your_client_secret CallbackUrl = your_callback_url

Execute SQL to Aha

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\aha.apip;ProfileSettings = 'Domain = acmeinc';Authscheme = OAuth;OAuthClientId = your_client_id;OAuthClientSecret = your_client_secret;CallbackUrl = your_callback_url;') cursor = cnxn.cursor() cursor.execute("SELECT Id, Name FROM Ideas WHERE AssignedToUserId = 'my_user_id'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Name)

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