Blazor でPaddle のデータにリアルタイムで連携するアプリを構築

Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。

CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってPaddle を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からPaddle に接続して直接SQL クエリを実行する方法を説明します。

CData ADO.NET Provider for API のインストール

CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、Paddle のデータへもRDB と同感覚でアクセスが可能になります。

CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。Paddle ADO.NET Data Provider で検索してください。

SELECT Paddle のデータ from the Blazor App

1. Open the Index.razor file from the Project page.
2. In a APIConnection object, set the connection string:

   API キー認証の設定

   Paddle は API キー認証を使用します。API キーを取得するには、以下のステップで進めます：

   1. https://vendors.paddle.com で Paddle アカウントにサインインします
   2. Developer Tools > Authentication に移動します
   3. 「Generate API Key」をクリックします
   4. アクセスしたいデータに対して適切な権限を割り当てます
   5. 生成されたキーをコピーします（サンドボックスキーは pdl_sdbx_apikey_ で始まり、本番キーは pdl_live_apikey_ で始まります）

   API キーを取得したら、以下の接続プロパティを設定します：

   • AuthScheme：APIKey に設定します。
   ProfileSettings 接続プロパティには以下を設定します：
   • APIKey：Paddle の API キーに設定します。

   接続文字列の例

   Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
   

   Paddle への接続

   認証を設定すると、Paddle に接続して、Products、Customers、Subscriptions、Transactions などの利用可能なテーブルからデータをクエリできます。

   For example: Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

   Blazor でPaddle にデータ連携するアプリを構築

   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 でPaddle のデータをSELECT

   サンプルプロジェクトの「Page」→「Index.razor」を開きます。

   以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Paddle 固有の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\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";"))
                 {
                     var sql = "SELECT ,  FROM Products WHERE  = ''";
                     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>
       

   API キー認証の設定

   Paddle は API キー認証を使用します。API キーを取得するには、以下のステップで進めます：

   1. https://vendors.paddle.com で Paddle アカウントにサインインします
   2. Developer Tools > Authentication に移動します
   3. 「Generate API Key」をクリックします
   4. アクセスしたいデータに対して適切な権限を割り当てます
   5. 生成されたキーをコピーします（サンドボックスキーは pdl_sdbx_apikey_ で始まり、本番キーは pdl_live_apikey_ で始まります）

   API キーを取得したら、以下の接続プロパティを設定します：

   • AuthScheme：APIKey に設定します。
   ProfileSettings 接続プロパティには以下を設定します：
   • APIKey：Paddle の API キーに設定します。

   接続文字列の例

   Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
   

   Paddle への接続

   認証を設定すると、Paddle に接続して、Products、Customers、Subscriptions、Transactions などの利用可能なテーブルからデータをクエリできます。

   プロジェクトをリビルドして実行します。このようにPaddle からデータを直接取得し、HTML テーブル形式にレンダリングしています。

   

   もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。

   まとめ

   このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってPaddle にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。