Learn more
 

Ready to get started?

Connect to live data from Aha with the API Driver

Connect to Aha

In this article

Related articles

Connect to Aha Data in DBArtisan


Use wizards in DBArtisan to configure Aha data as a data source.

The CData ODBC Driver for Aha seamlessly integrates Aha data into database management tools like DBArtisan by enabling you to access Aha data as a database. This article shows how to create an data source for Aha in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Aha Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then follow the steps below to register Aha data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic ODBC.
  3. Enter a name for the data source and select the DSN.
  4. Finish the wizard to connect to Aha data. Aha entities are displayed in the Datasource Explorer.

You can now work with Aha data as you work with any other database. See the driver help documentation for more information on the queries supported by the Aha API.