接続の確立

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

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module TrelloCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module TrelloCmdlets;

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

$conn = Connect-Trello -APIKey "myApiKey" -Token="myGeneratedToken"

Trello への接続

Trello は、トークンベース認証を使用してサードパーティアプリケーションにAPI へのアクセスを許可します。ユーザーがアプリケーションにデータへのアクセスを許可すると、アプリケーションにはTrello のAPI へのリクエストに使用できるトークンが付与されます。

Trello API は、Trello 自身の認可ルート、またはOAuth 経由でアクセスできます。

Trello 認可ルート

登録の時点で、Trello はAPI キーとトークンをアカウントに割り当てます。

認可ルート経由のアクセスを有効にするには：

AuthScheme をToken に設定します。
アカウントのAPI キーを取得するには：
- Trello にログインします。
- https://trello.com/app-key にアクセスします。
このURLを調整します：https://trello.com/1/authorize?expiration=never&name=MyPersonalToken&scope=read,write,account&response_type=token&key={Key} key を、取得したAPI キーに変更します。
URL にアクセスします。
トークンの有効期間を変更するには、expiration= フィールドを変更します。有効な値は、1hour、1day、30days、および never です。
アプリケーションにアカウントの使用を認可するには、Allow をクリックします。Trello はトークンのページにリダイレクトします。
次の接続プロパティを設定します。
- APIKey = https://trello.com/app-key にあるキー。
- Token = 取得したトークン。

API キーとトークンの両方が取得できたら、Trello APIへのリクエストの準備は完了です。

OAuth

認可の使用と同様に、OAuth は、アカウントの作成時にApplication Id とSecret を作成します。Web、デスクトップ、またはヘッドレスサーバーからOAuth を介して認証するには、カスタムOAuth アプリケーションの作成で説明するとおり、AuthScheme をOAuth に設定してカスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのTrello への認証について詳しく説明します。

デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。
Web：共有ウェブサイト経由でデータにアクセスします。
ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。

カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成を参照してください。

Trello で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

デスクトップアプリケーション

カスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

OAuth アクセストークンの取得およびリフレッシュ：

InitiateOAuth = GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
OAuthClientId = アプリケーションの登録時に割り当てられたクライアントId。
OAuthClientSecret = アプリケーションの登録時に割り当てられたクライアントシークレット。
CallbackURL = アプリケーションの登録時に定義されたリダイレクトURI。

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

アクセストークンの期限が切れたときは、本製品は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

本製品がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

はじめてデータに接続する前に、次の接続プロパティを設定します。
- InitiateOAuth = REFRESH。
- OAuthClientId = アプリケーション設定のクライアントId。
- OAuthClientSecret = アプリケーション設定のクライアントシークレット。
- OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation = 本製品がOAuth 値を保存する場所のパス。これは接続間で維持されます。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

ヘッドレスマシン

ヘッドレスマシンに置かれているリソースにログインする必要がある場合は、インターネットブラウザに対応した別の端末で認証する必要があります。以下のいずれかの方法で行います。

オプション1：OAuthVerifier 値を取得します。
オプション2：インターネットブラウザに対応したマシンに本製品をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。

オプション1またはオプション2を実行後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。

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

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。以下の手順に従います。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得します。

次のプロパティを設定します。
- InitiateOAuth = OFF。
- OAuthClientId = アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret = アプリケーションの登録時に割り当てられたクライアントシークレット。
GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャは、カスタムOAuth アプリケーションが登録されたときに構築されたCallbackURL を返します。（カスタムOAuth アプリケーションの作成を参照してください。）

このURL をコピーして、新しいブラウザのタブに貼り付けます。
ログインして、本製品にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。
OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
- InitiateOAuth = REFRESH。
- OAuthVerifier = 控えておいたverifier code（リダイレクトURI のcode パラメータの値）。
- OAuthSettingsLocation = 暗号化されたOAuth 認証値を指定されたファイルに永続化。
- OAuthClientId = カスタムOAuth アプリケーション設定のクライアントId。
- OAuthClientSecret = カスタムOAuth アプリケーション設定のクライアントシークレット。
接続をテストしてOAuth 設定ファイルを生成します。
次のプロパティを再設定して、接続してください。
- InitiateOAuth = REFRESH。
- OAuthSettingsLocation = 暗号化されたOAuth 認証値を含むファイル。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。
- OAuthClientId = アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret = アプリケーションの登録時に割り当てられたクライアントシークレット。

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

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

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

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

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

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

データの取得

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

$results = Select-Trello -Connection $conn -Table "Cards" -Columns @("Name, ListId") -Where "CardId='614060b2c37da423f30dc7d6'"

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

cmdlet 出力のパイプ処理

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

Select-Trello -Connection $conn -Table Cards -Where "CardId = '614060b2c37da423f30dc7d6'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCardsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Trello -APIKey "myApiKey" -Token="myGeneratedToken"
PS C:\> $row = Select-Trello -Connection $conn -Table "Cards" -Columns (Name, ListId) -Where "CardId = '614060b2c37da423f30dc7d6'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Cards",
  "Columns":  [

  ],
  "Name":  "MyName",
  "ListId":  "MyListId"
}

データの削除

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

Select-Trello -Connection $conn -Table Cards -Where "CardId = '614060b2c37da423f30dc7d6'" | Remove-Trello

データの変更

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

Import-Csv -Path C:\MyCardsUpdates.csv | %{
  $record = Select-Trello -Connection $conn -Table Cards -Where ("CardId = `'"+$_.CardId+"`'")
  if($record){
    Update-Trello -Connection $conn -Table Cards -Columns @("Name","ListId") -Values @($_.Name, $_.ListId) -Where "CardId  = `'$_.CardId`'"
  }else{
    Add-Trello -Connection $conn -Table Cards -Columns @("Name","ListId") -Values @($_.Name, $_.ListId)
  }
}

Cmdlets for Trello