Blazor でPrintify のデータにリアルタイムで連携するアプリを構築
Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。
CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってPrintify を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からPrintify に接続して直接SQL クエリを実行する方法を説明します。
CData ADO.NET Provider for API のインストール
CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、Printify のデータへもRDB と同感覚でアクセスが可能になります。
CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。Printify ADO.NET Data Provider で検索してください。
Blazor でPrintify にデータ連携するアプリを構築
Blazor にADO.NET Provider for API を接続
- Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
- ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
- 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for API 2019J\lib etstandard2.0」内のSystem.Data.CData.API.dll」を参照に選びます。
Blazor でPrintify のデータをSELECT
サンプルプロジェクトの「Page」→「Index.razor」を開きます。
以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Printify 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for API の強味です。
@page "/"
@using System.Data;
@using System.Data.CData.API;
<h1>Hello, world!</h1>
Welcome to your Data app.
<div class="row">
<div class="col-12">
@using (APIConnection connection = new APIConnection(
"Profile=C:\profiles\Printify.apip;ProfileSettings='APIKey=your_personal_token';"))
{
var sql = "SELECT Id, ShippingMethod FROM Tags WHERE Status = 'pending'";
var results = new DataTable();
APIDataAdapter dataAdapter = new APIDataAdapter(sql, connection);
dataAdapter.Fill(results);
<table class="table table-bordered">
<thead class="thead-light">
<tr>
@foreach (DataColumn item in results.Rows[0].Table.Columns)
{
<th scope="col">@item.ColumnName</th>
}
</tr>
</thead>
<tbody>
@foreach (DataRow row in results.Rows)
{
<tr>
@foreach (var column in row.ItemArray)
{
<td>@column.ToString()</td>
}
</tr>
}
</tbody>
</table>
}
</div>
</div>
まず、Profile 接続プロパティにPrintify プロファイルのディスク上の場所を設定します（例：C:\profiles\Profile.apip）。次に、ProfileSettings 接続プロパティにPrintify の接続文字列を設定します（以下を参照）。
Printify API プロファイル設定
Printify に認証するには、API Key を提供する必要があります。API Key を取得するには、My Profile に移動し、次にConnections に移動します。Connections セクションで、Personal Access Token（API Key）を生成し、Token Access Scopes を設定できます。Personal Access Token の有効期限は1年間です。有効期限が切れたPersonal Access Token は、同じ手順で再生成できます。ProfileSettings プロパティにPersonal Access Token をAPI Key として設定して接続します。
プロジェクトをリビルドして実行します。このようにPrintify からデータを直接取得し、HTML テーブル形式にレンダリングしています。
もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。