Learn more
 

Ready to get started?

Connect to live data from Aha with the API Driver

Connect to Aha

In this article

Related articles

How to Query Aha Data in MySQL Workbench


Execute MySQL queries against live Aha data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Aha to query Aha data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Aha data in MySQL Workbench.

Connect to Aha Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Aha data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Aha from MySQL Workbench

The steps below outline connecting to the virtual Aha database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Aha data.

Connect to Aha through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Aha).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Aha Data

  1. Open the connection you just created (CData SQL Gateway for Aha).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Aha data, like SELECT * FROM `CData API Sys`.Ideas;

With access to live Aha data from MySQL Workbench, you can easily query and update Aha, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.