CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でShipStation Cmdlets を使用する例を示します。

ShipStation への接続には、BASIC 認証標準を使います。

ShipStation への接続

1. ShipStation アカウント: ShipStation Login にログインします。
2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
3. ［アカウント］->［API 設定］をクリックします。
4. ［API 設定］ページで、API Key とAPI Secret を書き留めます。

ShipStation への認証

• APIKey：［API 設定］ページのAPI Key に設定。
• APISecret：［API 設定］ページのSecret key に設定。

接続オブジェクトの作成

Connect-ShipStation cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-ShipStation -APIKey "YourAPIKey" -APISecret "YourAPISecret"

データの取得

Select-ShipStation cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-ShipStation -Connection $conn -Table "Tags" -Columns @("Id, Color") -Where "CustomerId='1368175'"

Invoke-ShipStation cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-ShipStation -Connection $conn -Table Tags -Where "CustomerId = '1368175'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTagsData.csv -NoTypeInformation

Select-ShipStation からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-ShipStation -APIKey "YourAPIKey" -APISecret "YourAPISecret"
PS C:\> $row = Select-ShipStation -Connection $conn -Table "Tags" -Columns (Id, Color) -Where "CustomerId = '1368175'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Tags",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Color":  "MyColor"
}