Automate OnePageCrm Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

Start by setting the Profile connection property to the location of the OnePageCrm Profile on disk (e.g. C:\profiles\OnePageCrm.apip). Next, set the ProfileSettings connection property to the connection string for OnePageCrm (see below).

OnePageCrm API Profile Settings

In your OnePageCRM account, go to Apps and Integrations > API (Developer Access) > Configuration to find your User ID and 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 OnePageCrm:

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

    $sql="SELECT Id, ContactId from Actions"
    
    $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 $_.contactid
    }
      

Ready to get started?

Connect to live data from OnePageCrm with the API Driver

Connect to OnePageCrm