Webflow のデータをApache Kafka トピックにストリーミング

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData JDBC Driver とKafka Connect JDBC コネクタを使用して、Apache Kafka でWebflow のデータにアクセスし、ストリーミングできます。

Apache Kafka は、主にリアルタイムデータパイプラインやイベント駆動型アプリケーションの構築に使用されるオープンソースのストリーム処理プラットフォームです。CData API Driver for JDBCと組み合わせることで、Kafka はライブのWebflow のデータを扱うことができます。この記事では、Webflow データをApache Kafka トピックに接続、アクセス、ストリーミングする方法と、Confluent Control Center を起動してConfluent プラットフォームのKafka インフラストラクチャを使用して受信したWebflow のデータをユーザーが安全に管理および監視できるようにする方法について説明します。

CData JDBC Driver は最適化されたデータ処理機能を内蔵しており、ライブのWebflow のデータとのやり取りにおいて比類のないパフォーマンスを提供します。Webflow に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Webflow にプッシュし、サポートされていない操作(多くの場合SQL 関数やJOIN 操作)については組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してWebflow のデータを操作および分析できます。

前提条件

Apache Kafka トピックでWebflow のデータをストリーミングするためにCData JDBC Driver を接続する前に、クライアントのLinux ベースのシステムに以下をインストールおよび設定してください。

  1. Confluent Platform for Apache Kafka
  2. Confluent Hub CLI のインストール
  3. Confluent Platform 用のSelf-Managed Kafka JDBC Source Connector

Webflow のデータへの新しいJDBC 接続を定義

  1. Linux ベースのシステムにCData API Driver for JDBCをダウンロードします。
  2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
    1. Webflow という名前の新しいディレクトリを作成します。
      		mkdir API
      		
    2. ダウンロードしたドライバーファイル(.zip)をこの新しいディレクトリに移動します。
      		mv APIJDBCDriver.zip API/
      		
    3. CData APIJDBCDriver の内容をこの新しいディレクトリに解凍します。
      		unzip APIJDBCDriver.zip
      		
  3. Webflow ディレクトリを開き、lib フォルダに移動します。
    ls
    cd lib/
    
  4. CData API Driver for JDBClib フォルダの内容をKafka Connect JDBClib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.api.jar ファイルがlib フォルダに正常にコピーされたことを確認します。
    cp -r /path/to/CData API Driver for JDBC/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
    cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
    
  5. 以下のコマンドを使用して、CData Webflow JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。
    	java -jar cdata.jdbc.api.jar -l
    	
  6. プロダクトキーまたは"TRIAL" を入力します(ライセンスの有効期限が切れた場合は、CData サポートチームまでお問い合わせください)。
  7. 以下のコマンドを使用してConfluent ローカルサービスを起動します:
    	confluent local services start
    	

    これにより、Zookeeper、Kafka、Schema Registry、Kafka REST、Kafka CONNECT、ksqlDB、Control Center などのすべてのConfluent サービスが起動します。これで、CData JDBC Driver for Webflow を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。

    Confluent ローカルサービスを起動
  8. POST HTTP API リクエストを使用してKafka トピックを手動で作成します:
     curl --location 'server_address:8083/connectors'
    	--header 'Content-Type: application/json'
    	--data '{ 
    		"name": "jdbc_source_cdata_api_01", 
    		"config": { 
    			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", 
    			"connection.url": "jdbc:api:Profile=C:\profiles\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;",
    		"topic.prefix": "api-01-", 
    		"mode": "bulk" 
    		} 
    	}'
    

    HTTP POST 本文(上記)で使用されるフィールドについて説明します:

    • connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
    • connection.url: Webflow データに接続するためのJDBC 接続URL です。

      組み込みの接続文字列デザイナー

      JDBC URL の作成については、CData API Driver for JDBCに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

      		java -jar cdata.jdbc.api.jar
      		

      接続プロパティを入力し、接続文字列をクリップボードにコピーします。

      認証

      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 - 認可されたユーザーへの読み取りアクセス
      組み込みの接続文字列デザイナーを使用してJDBC URL を生成(Salesforce の例)
    • topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「api-01-」に設定されています。
    • mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。

    このリクエストにより、Webflow のすべてのテーブル/コンテンツがKafka トピックとして追加されます。

    注意: リクエストをPOST するIP アドレス(サーバー)は、Linux ネットワークのIP アドレスです。

  9. ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します:
    ksql
    list topics;
    
    Kafka トピックを一覧表示(BigCommerce の例)
  10. トピック内のデータを表示するには、以下のSQL ステートメントを入力します:
    PRINT topic FROM BEGINNING;
    

Confluent Control Center への接続

Confluent Control Center のユーザーインターフェースにアクセスするには、上記のセクションで説明した"confluent local services" を実行し、ローカルブラウザでhttp://<server address>:9021/clusters/ と入力してください。

Confluent Control Center に接続

おわりに

CData API Driver for JDBCの30日間無償トライアルをダウンロードして、Webflow データをApache Kafka にストリーミングしましょう。ご不明な点があれば、サポートチームまでお問い合わせください。

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

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

Webflow に接続