Automate Copper Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

Copper API Profile Settings

In Copper CRM, go to Settings > Integrations > API Keys and click Generate API Key. Provide both the API key and the email address associated with your account.

  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 Copper:

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

    $sql="SELECT Id, Name from Account"
    
    $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
    }
      

Ready to get started?

Connect to live data from Copper with the API Driver

Connect to Copper