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

杉本和也
杉本和也
リードエンジニア
ASP.NET Core Blazor C# でWebflow にSQL でクエリ。



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

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

Blazor はADO.NET Provider の利用が可能

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

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

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

NuGet でADO.NET Webflow Provider をインストール

SELECT Webflow のデータ from the Blazor App

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

    認証

    Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。

    OAuth 2.0 のセットアップと設定

    ステップ 1:Webflow OAuth アプリケーションの作成

    OAuth 認証をセットアップするには、以下のステップで進めます:

    1. Webflow Developer Portal にアクセスします
    2. Webflow アカウントの「Apps & Integrations」に移動します
    3. 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
    4. アプリケーション名、説明、リダイレクト URI(CallbackURL)を設定します
    5. 接続で使用する Client ID と Client Secret をコピーします

    必須の接続プロパティ

    • AuthScheme:OAuth に設定します(必須)
    • OAuthClientId:Webflow OAuth アプリケーションの Client ID(必須)
    • OAuthClientSecret:Webflow OAuth アプリケーションの Client Secret(必須)
    • CallbackURL:OAuth アプリケーションで指定したリダイレクト URI(必須)
    • InitiateOAuth:トークンを自動管理するには GETANDREFRESH に設定します(推奨)

    必須の OAuth スコープ

    Webflow API プロファイルでは、以下の OAuth スコープが必要です:

    • sites:read - サイト情報および設定への読み取りアクセス
    • pages:read - サイトページへの読み取りアクセス
    • cms:read - CMS コレクションおよびアイテムへの読み取りアクセス
    • forms:read - フォームおよびフォーム送信への読み取りアクセス
    • assets:read - メディアアセットおよびフォルダーへの読み取りアクセス
    • ecommerce:read - 製品、注文、在庫への読み取りアクセス
    • authorized_user:read - 認可されたユーザーへの読み取りアクセス

    For example: Profile=C:\profiles\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

    Blazor にADO.NET Provider for API を接続

    • Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
    • Blazor アプリを作成
    • ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
    • 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for API 2019J\lib etstandard2.0」内のSystem.Data.CData.API.dll」を参照に選びます。
    • ADO.NET for API の.dll をBlazor アプリから参照

    Blazor でWebflow のデータをSELECT

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

    以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Webflow 固有の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\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"))
                  {
                      var sql = "SELECT ,  FROM Sites WHERE Id = 'your_site_id'";
                      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>
        

    認証

    Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。

    OAuth 2.0 のセットアップと設定

    ステップ 1:Webflow OAuth アプリケーションの作成

    OAuth 認証をセットアップするには、以下のステップで進めます:

    1. Webflow Developer Portal にアクセスします
    2. Webflow アカウントの「Apps & Integrations」に移動します
    3. 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
    4. アプリケーション名、説明、リダイレクト URI(CallbackURL)を設定します
    5. 接続で使用する Client ID と Client Secret をコピーします

    必須の接続プロパティ

    • AuthScheme:OAuth に設定します(必須)
    • OAuthClientId:Webflow OAuth アプリケーションの Client ID(必須)
    • OAuthClientSecret:Webflow OAuth アプリケーションの Client Secret(必須)
    • CallbackURL:OAuth アプリケーションで指定したリダイレクト URI(必須)
    • InitiateOAuth:トークンを自動管理するには GETANDREFRESH に設定します(推奨)

    必須の OAuth スコープ

    Webflow API プロファイルでは、以下の OAuth スコープが必要です:

    • sites:read - サイト情報および設定への読み取りアクセス
    • pages:read - サイトページへの読み取りアクセス
    • cms:read - CMS コレクションおよびアイテムへの読み取りアクセス
    • forms:read - フォームおよびフォーム送信への読み取りアクセス
    • assets:read - メディアアセットおよびフォルダーへの読み取りアクセス
    • ecommerce:read - 製品、注文、在庫への読み取りアクセス
    • authorized_user:read - 認可されたユーザーへの読み取りアクセス

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

    Blazor アプリからWebflow のデータをクエリ

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

    まとめ

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

はじめる準備はできましたか?

API Driver で Webflow のライブデータに接続

Webflow に接続