DBeaver からWebflow のデータに連携して可視化する方法とは?
CData JDBC Driver for API は、IDE からBI ツールまで、サードパーティーツールからWebflow のデータの読み書きを可能にするJDBC 標準を提供します。本記事では、DBeaver のウィザードを使ってWebflow のデータに接続し、GUI 上でデータを参照する方法を紹介します。
CData JDBC ドライバとは?
CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。
- Webflow をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
- DBeaver を含む多様なアプリケーション、ツールにWebflow のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData JDBC ドライバでは、1.データソースとしてWebflow の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData JDBC ドライバのインストールとWebflow への接続設定
まずは、本記事右側のサイドバーからAPI JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
次に、以下の手順でDBeaver にドライバーのJAR ファイルをロードします。
- DBeaver アプリケーションを開き、「データベース」メニューの「ドライバーマネジャー」オプションを選択します。「新規」をクリックして「新しいドライバを作成する」フォームを開きます。
- 設定タブで:
- ドライバ名をわかりやすい名前に設定します(例:CData JDBC Driver for Webflow)。
- クラス名をJDBC ドライバーのクラス名「cdata.jdbc.api.APIDriver」に設定します。
- URL テンプレートをjdbc:api: に設定します。
- ライブラリタブで「ファイルを追加」をクリックし、インストールディレクトリ(C:\Program Files\CData\CData JDBC Driver for Webflow XXXX\)の「lib」フォルダに移動してJAR ファイル(cdata.jdbc.API.jar)を選択します。
Webflow のデータの接続を作成
以下の手順で、認証情報およびその他の必要な接続プロパティを追加します。
- 「データベース」メニューで、「新しい接続」をクリックします。
- 表示される「新しい接続を作成する」 ウィザードで、先ほど作成したドライバー(例:CData JDBC Driver for Webflow)を選択し、「次へ >」をクリックします。
- 設定ウィザードの一般タブで、以下を参考に必要な接続プロパティを使用してJDBC URL を設定します。
認証
Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。
OAuth 2.0 のセットアップと設定
ステップ 1:Webflow OAuth アプリケーションの作成
OAuth 認証をセットアップするには、以下のステップで進めます:
- Webflow Developer Portal にアクセスします
- Webflow アカウントの「Apps & Integrations」に移動します
- 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
- アプリケーション名、説明、リダイレクト URI(CallbackURL)を設定します
- 接続で使用する 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 - 認可されたユーザーへの読み取りアクセス
組み込みの接続文字列デザイナー
JDBC URL の作成の補助として、Webflow JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
一般的な接続文字列:
jdbc:api:Profile=C:\profiles\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
- 「テスト接続」をクリックして、接続が正しく設定されていることを確認します。
- 「終了」をクリックします。
Webflow のデータにクエリを実行
これで、接続できたことで公開されたテーブルのデータにクエリを実行できるようになりました。テーブルを右クリックし、「ビュー表」をクリックします。「データ」タブでデータを確認できます。