Choreo でAPI とデータ連携するアプリを作成

古川えりか
古川えりか
コンテンツスペシャリスト
CData Connect AI を使ってChoreo からAPI に接続し、リアルタイムAPI のデータと連携するカスタムアプリを構築します。

Choreo は、ローコードおよびクラウドネイティブなSaaS 開発のための多機能かつ包括的なプラットフォームです。 開発者は、高度なコーディングスキルがなくても、Choreo のローコード環境を利用することで簡単にアプリケーションを構築することができます。 さらにCData Connect AI と連携することで、アプリケーションにAPI のデータへのクラウドベースのアクセスを即座に追加できます。 この記事では、Connect AI からAPI に接続し、Choreo からリアルタイムAPI のデータにアクセスするアプリケーションを作成する方法を紹介します。

CData Connect AI は、API にクラウドベースのインターフェースを提供し、ネイティブにサポートされているデータベースにデータを複製することなくChoreo でリアルタイムAPI のデータを使用するアプリケーションを構築できるようにします。 CData Connect AI は最適化されたデータ処理により、サポートされているすべてのSQL 操作（フィルタ、JOIN など）をAPI に直接発行し、サーバー側の処理を利用して要求されたAPI のデータを高速で返します。

Connect AI からAPI への接続

CData Connect AI を使うと、直感的なクリック操作ベースのインターフェースを使ってデータソースに接続できます。

  1. Connect AI にログインし、 Add Connection をクリックします。 Adding a Connection
  2. Add Connection パネルで「API」を選択します。 Selecting a data source
  3. 必要な認証プロパティを入力し、API に接続します。

    To connect to your API, configure the following properties on the Global Settings page:

    • In Authentication, select the Type and fill in the required properties
    • In Headers, add the required HTTP headers for your API
    • In Pagination, select the Type and fill in the required properties

    After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

    1. Click "+ Add"
    2. Set the Name for the table
    3. Set Request URL to the API endpoint you wish to work with
    4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
    5. (Optional) In Headers, add the required HTTP headers for the API endpoint
    6. In Table Data click " Configure"
    7. Review the response from the API and click "Next"
    8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next"
    9. Preview the tabular model of the API response and click "Confirm"
    Configuring a connection (Salesforce is shown)
  4. Create & Test をクリックします。
  5. Add API Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。 Updating permissions

パーソナルアクセストークンの取得

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用する個人用アクセストークン（PAT）を作成できます。 きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

  1. Connect AI アプリの右上にあるユーザー名をクリックし、User Profile をクリックします。
  2. User Profile ページでPersonal Access Token セクションにスクロールし、 Create PAT をクリックします。
  3. PAT の名前を入力して Create をクリックします。 Creating a new PAT
  4. 個人用アクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

接続の設定が完了したら、Choreo からAPI のデータに接続できるようになります。

Choreo からAPI への接続

以下のステップでは、Choreo からCData Connect AI に接続し、リアルタイムAPI のデータにアクセスできる新しいアプリケーションを作成する方法を紹介します。

コンストラクトを作成する

  1. Choreo プラットフォームにサインインします。Note：この記事は、Anonymously を選択した場合について説明しています。 Displaying Choreo landing page
  2. 左サイドバーからComponents を選択し、+Create をクリックします。次に、Manual Trigger を選択し、続けてStart from scratch を選択します。 Selecting manual trigger
  3. マニュアルトリガーのName とDescription を入力し、Create をクリックします。 Creating manual trigger
  4. トリガーが作成されたら、Edit Code をクリックします。 Clicking Edit Code
  5. Ballerina Low-Code IDE が表示されます。Choreo は、ローコードダイアグラムビューでコンストラクトを自動生成します。 このコンストラクトをハイライトしてゴミ箱アイコンをクリックし、削除します。 Showing Ballerina Low-Code IDE
  6. 画面上部の + アイコンをクリックし、右サイドのAdd Constructs ツールバーにあるMain を選択します。 続けてFunction Configuration フォームでSave をクリックします。 Adding a Construct

CData Connect AI コネクタを追加する

  1. 楕円形のSTART とEND の間にある + アイコンをクリックして、Connector をクリックします。
    2. Adding a Connector
  2. 右サイドバーのConnectors で「CData」を検索します。CData Connect をクリックしてConnector 設定ペインを開きます。
    3. Searching for CData Connector
  3. Connector 設定ペインで、構成の設定を入力します。
    • 使用するEndpoint Name を入力します。例では「connectEndpoint」を使用しています。
    • User フィールドに、CData Connect AI ユーザーのE メールアドレスを引用符で囲んで入力します（例："[email protected]"）。
    • Password フィールドに、前述の生成されたPAT を引用符で囲んで入力します（例："SampleToken"）。
    4. Configuring an endpoint
  4. Save をクリックすると、CData Connect AI のロゴがついたローコードエディタが表示されます。
    5. Displaying the new CData connector

クエリのアクションを追加する

  1. new とend の間の + アイコンをクリックし、Action を選択して既存のコネクタエンドポイントを選択します。
    2. Creating an Action
  2. connector Operation クエリを選択します。右側にAction ペインが表示されます。
    3. Showing Action pane
  3. API のデータを取得するためのSQL クエリを、query のsqlQuery パラメータとして入力します。次に例を示します。 
    			SELECT * FROM API1.API.posts LIMIT 10
    • クエリを入力する際、カタログにConnection Name を、スキーマにData Source Name を必ず指定してください。例えば、API1.API です。
    • これらのパラメータはCData Connect AI ダッシュボードのConnections ページに表示されます。

API のデータを反復処理する

  1. コードエディタの右上にあるShow Source アイコンをクリックします。
  2. ballerina/io ライブラリをインポートするimport 文を追加します。 
    		
		import ballerina/io;
  3. 次に、SQL クエリの結果を繰り返し処理するために、query アクションの後にfrom 文を追加します。
    4. 		
		check from record{} result in resultStream
		do {
			io:println("Full posts details: ", result);
		};
  4. コンストラクトのコードは次のようになります。
    5. 			
			import ballerinax/cdata.connect;
			import ballerinax/cdata.connect.driver as _;
			import ballerina/io;

			public function main() returns error? {
				connect:Client connectEp = check new (user = "connect_cloud_username", password="connect_cloud_pat");

				stream<record {}, error=""?> resultStream =
				connectEp->query(sqlQuery = `SELECT * FROM API1.API.posts LIMIT 10`);

				check from record{} result in resultStream
				do {
					io:println("Full posts details: ", result);
				};
			}
  5. Save をクリックしてアクションを保存します。次のようなダイアグラムになります。
    6. Displaying the new endpoint in Ballerina

プログラムをデプロイする

必要とするアクションをすべてプログラムに追加したら、次のステップに進みます。

  1. Web エディタで最終的なソースコードをコミットしてプッシュし、その変更をChoreo プラットフォームに同期します。
  2. Choreo Console の左ナビゲーションバーでDeploy をクリックします。
  3. Build Area でConfigure & Deploy をクリックし、プログラムをデプロイします。
  4. プロンプトが表示されたら、先ほど使用したCData Connect AI のユーザー名とパスワードを入力し、Deploy をクリックします。
    5. Deploying the program

Choreo でリアルタイムAPI のデータにアクセスできるアプリケーションを作成できました。

CData Connect AI の入手

Choreo をCData Connect AI で連携するための詳細は、CData Connect Ballerina Guide を参照してください。 CData Connect AI の14日間無償トライアルを利用して、クラウドアプリケーションから100を超えるSaaS、ビッグデータ、NoSQL データソースへのダイレクトなSQL アクセスをお試しください！

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

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ

この記事の内容

関連記事