各製品の資料を入手。
詳細はこちら →
Blazor でShipStation のデータにリアルタイムで連携するアプリを構築
ASP.NET Core Blazor C# でShipStation にSQL でクエリ。
最終更新日：2021-11-03
この記事で実現できるShipStation 連携のシナリオ
こんにちは！リードエンジニアの杉本です。
Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。
CData ADO.NET Provider for ShipStation は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってShipStation を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からShipStation に接続して直接SQL クエリを実行する方法を説明します。
CData ADO.NET Provider for ShipStation のインストール
CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、ShipStation のデータへもRDB と同感覚でアクセスが可能になります。
CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。ShipStation ADO.NET Data Provider で検索してください。
Blazor でShipStation にデータ連携するアプリを構築
Blazor にADO.NET Provider for ShipStation を接続
- Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
- ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
- 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for ShipStation 2019J\lib etstandard2.0」内のSystem.Data.CData.ShipStation.dll」を参照に選びます。
Blazor でShipStation のデータをSELECT
サンプルプロジェクトの「Page」→「Index.razor」を開きます。
以下のコードを書きます。使っているクエリはおなじみの標準SQL です。ShipStation 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for ShipStation の強味です。
@page "/"
@using System.Data;
@using System.Data.CData.ShipStation;
<h1>Hello, world!</h1>
Welcome to your Data app.
<div class="row">
<div class="col-12">
@using (ShipStationConnection connection = new ShipStationConnection(
"APIKey='YourAPIKey';APISecret='YourAPISecret'"))
{
var sql = "SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'";
var results = new DataTable();
ShipStationDataAdapter dataAdapter = new ShipStationDataAdapter(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>
ShipStation 接続プロパティの取得・設定方法
ShipStation への接続には、BASIC 認証標準を使います。
- ShipStation アカウントにログインします。
- 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
- ［アカウント］->［API 設定］をクリックします。
- ［API 設定］ページで、API Key とAPI Secret を書き留めます。
ShipStation への認証
- APIKey：［API 設定］ページのAPI Key に設定します。
- APISecret：［API 設定］ページのSecret key に設定します。
プロジェクトをリビルドして実行します。このようにShipStation からデータを直接取得し、HTML テーブル形式にレンダリングしています。
もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。
まとめ
このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってShipStation にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。関連コンテンツ
