Automate ConvertAPI Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access ConvertAPI data from PowerShell? This article demonstrates how to utilize the ConvertAPI Cmdlets for tasks like connecting to ConvertAPI 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 ConvertAPI.

ADO.NET Provider

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

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

ConvertAPI uses API Secret Key authentication. Your ConvertAPI Secret is used to authenticate requests. You can find your API Secret in the ConvertAPI dashboard under your account settings.

Using APIKey Authentication

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your ConvertAPI API secret key.

Example connection string:

Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
  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 ConvertAPI:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

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

Ready to get started?

Connect to live data from ConvertAPI with the API Driver

Connect to ConvertAPI