PowerShell からShippo のデータに接続してデータの取得・CSV エクスポートを実行する方法

CData Cmdlets for API を使えば、PowerShell からShippo に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、Shippo への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

Shippo への接続を設定

それでは、まずはShippo への接続設定からはじめていきましょう。接続設定にはCData Shippo Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module APICmdlets;

Connect-API コマンドを使ってShippo との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-API  -Profile "$Profile" -ProfileSettings "$ProfileSettings"

まず、Profile 接続プロパティにShippo プロファイルのディスク上の場所を設定します（例：C:\profiles\Shippo.apip）。次に、ProfileSettings 接続プロパティにShippo の接続文字列を設定します（以下を参照）。

Shippo API プロファイル設定

Shippo に認証するには、API Key が必要です。このAPI Key は「Settings」>「API」>「Generate Token」で確認できます。キーを生成した後、ProfileSettings 接続プロパティのAPIKey に設定します。

これで接続設定は完了です。

Shippo のデータを取得してCSV にパイプライン

接続が完了したので、Orders テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-API -Connection $conn -Table Orders | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

このコードでは、Select-API から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

おわりに

このように、CData Cmdlets を使えばPowerShell でのShippo のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。