接続の確立

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

BigCommerce への接続

BigCommerce を認証する方法は2つあります。

BigCommerce ユーザーインターフェースで生成されたトークンを使用。
カスタムBigCommerce アプリケーションで作成されたOAuth 資格情報を使用。

BigCommerce トークン

トークンを生成することで、BigCommerce に接続するための資格情報を取得できます。トークンは、特定のアカウント情報の共有を許可します。このフローでは、BigCommerce のUI で直接アプリケーションへのアクセス許可を明示的に作成および承認するため、実行時にWeb ブラウザは必要ありません。これは最も簡単な接続方法であり、個人または会社のデータにアクセスするだけのユーザーに推奨されます。

トークンの生成

BigCommerce ストアに接続してトークンを取得するには、以下のようにストアレベルのAPI アカウントを作成する必要があります。

BigCommerce アカウントにログインします。
Settings -> Store-level API Tokens -> +Create API Account に移動します。
Token type -> V2/V3 API Token を選択します。
アカウント名（4文字以上）を入力します。
API のパスをメモしてください。次のような構造です：https://api.bigcommerce.com/stores/{StoreId}/v3/。API アカウントを使用するには、このパスが必要です。 Note： Store Id はストアハッシュとも呼ばれます。
作成するAPI Account のOAuth Scopes を選択します。本製品は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
Save をクリックします。保存に成功すると、API 資格情報を含むポップアップウィンドウが表示されます。このポップアップウィンドウに戻ることはできないので、資格情報を保存してください。

以下の接続プロパティを設定することで、API 資格情報を使用してBigCommerce に接続できるようになります。

AuthScheme：PersonalAccessToken に設定。
StoreId：API パスから取得したStoreId（ストアハッシュ）に設定。
OAuthAccessToken：上記の手順で取得したAccess Token に設定。

BigCommerce カスタムアプリの作成

BigCommerce アプリの作成では、BigCommerce に接続するためのカスタムアプリを作成する方法について説明します。ここで詳しく説明する配布用のアプリケーションを作成する方法は、以下の各セクションで必要となります。

デスクトップアプリケーション
Web アプリケーション
ヘッドレスマシン

これらのすべてのケースでAuthScheme をOAUTH に設定する必要があります。以下のセクションは、すでに設定済みであることを前提として書かれています。

アプリの作成は単一のOAuthAccess トークンを生成するより複雑ですが、複数のクライアントに接続またはアクセスを許可する設計のクライアント統合や、複数のユーザーによって個別に承認されるアプリを作成する管理シナリオでは、より望ましい場合があります。

デスクトップアプリ

下記の手順に従って、カスタムOAuth アプリの資格情報を使用して認証します。詳しくは前述の「アクセストークンの生成」を参照してください。

OAuth アクセストークンの取得

次のプロパティを設定して、接続してください。

OAuthClientId：アプリ設定のクライアントId に設定。
OAuthClientSecret：アプリ設定のクライアントシークレットに設定。
CallbackURL：アプリ設定のリダイレクトURL に設定。
StoreId：StoreId に設定。

接続すると、本製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下の2つのオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：別のマシンに本製品をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
その後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、BigCommerce OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
  - InitiateOAuth：OFF に設定。
  - OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  - OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

InitiateOAuth：REFRESH に設定。
OAuthVerifier：verifier code に設定。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
OAuthSettingsLocation：ドライバーがOAuth トークン値を保存するファイルの場所に設定。これは接続間で維持されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。

接続オブジェクトの作成

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

$conn = Connect-BigCommerce -OAuthClientId -OAuthClientSecret -CallbackURL 'http://localhost:33333' -StoreId 'YoUrSToREId'

データの取得

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

$results = Select-BigCommerce -Connection $conn -Table "Customers" -Columns @("FirstName, LastName") -Where "Column2='Bob'"

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

cmdlet 出力のパイプ処理

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

Select-BigCommerce -Connection $conn -Table Customers -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-BigCommerce -OAuthClientId -OAuthClientSecret -CallbackURL 'http://localhost:33333' -StoreId 'YoUrSToREId'
PS C:\> $row = Select-BigCommerce -Connection $conn -Table "Customers" -Columns (FirstName, LastName) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Customers",
  "Columns":  [

  ],
  "FirstName":  "MyFirstName",
  "LastName":  "MyLastName"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-BigCommerce -Connection $conn -Table Customers -Where "Column2 = 'Bob'" | Remove-BigCommerce

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをBigCommerce にロードします。

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
  $record = Select-BigCommerce -Connection $conn -Table Customers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-BigCommerce -Connection $conn -Table Customers -Columns @("FirstName","LastName") -Values @($_.FirstName, $_.LastName) -Where "Id  = `'$_.Id`'"
  }else{
    Add-BigCommerce -Connection $conn -Table Customers -Columns @("FirstName","LastName") -Values @($_.FirstName, $_.LastName)
  }
}

Cmdlets for BigCommerce