Learn more
 

Ready to get started?

Connect to live data from Aha with the API Driver

Connect to Aha

In this article

Related articles

Rapidly Develop Aha-Driven Apps with Active Query Builder


Leverage the Active Query Builder SQL interface builder and the ease of .NET data access to create data-driven WinForms and ASP.NET apps.

Write standard .NET to expose Aha data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Aha enables standards-based access to Aha. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to Aha as an ODBC Data Source

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.

Use SQL to Interact with Aha

Follow the steps below to create a WinForms visual query builder.

  1. Open Active Query Builder for .NET WinForms.
  2. In the new Windows Forms project go to the "File" menu and click "Connect..."
  3. Under Database Connections, click "Add..."
  4. Set your desired Connection Name (e.g. CData Aha), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
  5. Click "OK" to save the new connection.
  6. Back in the Database Connection wizard, select the newly created connection and click "OK."
  7. Click "File" > "New Query" to create a QueryBuilder

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.