Ready to get started?

Connect to live data from Aha with the API Driver

Connect to Aha

Automate Aha Integration Tasks from PowerShell



Are you in search of a quick and easy way to access Aha data from PowerShell? This article demonstrates how to utilize the Aha Cmdlets for tasks like connecting to Aha data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Aha.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for Aha; this tutorial shows how to use the Provider to retrieve Aha data.

Once you have acquired the necessary connection properties, accessing Aha data in PowerShell can be enabled in three steps.

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.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
  2. Connect to Aha:

    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\aha.apip;ProfileSettings='Domain=acmeinc';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;") $conn.Open()
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Name from Ideas" $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { Write-Host $_.id $_.name }