Blazor でApprovalMax のデータにリアルタイムで連携するアプリを構築
Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。
CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってApprovalMax を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からApprovalMax に接続して直接SQL クエリを実行する方法を説明します。
CData ADO.NET Provider for API のインストール
CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、ApprovalMax のデータへもRDB と同感覚でアクセスが可能になります。
CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。ApprovalMax ADO.NET Data Provider で検索してください。
SELECT ApprovalMax のデータ from the Blazor App
- Open the Index.razor file from the Project page.
- In a APIConnection object, set the connection string:
まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。
ApprovalMax API プロファイル設定
ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。
まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。
Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme：OAuth に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
- OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
- CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
- Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。
OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。
For example: Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;
Blazor でApprovalMax にデータ連携するアプリを構築
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 でApprovalMax のデータをSELECT
サンプルプロジェクトの「Page」→「Index.razor」を開きます。
以下のコードを書きます。使っているクエリはおなじみの標準SQL です。ApprovalMax 固有の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\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;")) { var sql = "SELECT UserId, Email FROM UserProfiles WHERE CompanyId = '00000000-0000-0000-0000-000000000000'"; 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 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。
ApprovalMax API プロファイル設定
ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。
まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。
Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。
以下の接続プロパティを設定すると、接続できるようになります。
- AuthScheme：OAuth に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
- OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
- CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
- Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。
OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。
プロジェクトをリビルドして実行します。このようにApprovalMax からデータを直接取得し、HTML テーブル形式にレンダリングしています。
もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。
まとめ
このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってApprovalMax にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。