Automate Yotpo Integration Tasks from PowerShell

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

ADO.NET Provider

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

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

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

Yotpo API Profile Settings

To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

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

  • AuthScheme: Set this to OAuthClient.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to your Yotpo AppKey.
  • OAuthClientSecret: Set this to your Yotpo AppSecret.
  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 Yotpo:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

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

Ready to get started?

Connect to live data from Yotpo with the API Driver

Connect to Yotpo