Appsmith で API 連携アプリケーションを作成

Cameron Leblanc
Technology Evangelist

Appsmith でCData Connect AI を介して API のデータに接続し、API のデータにリアルタイムでアクセスできるカスタムビジネスアプリケーションを作成。

Appsmith は、チームがビジネスオペレーションを改善するためのUI を素早く簡単に構築できる、オープンソースの内部ツールビルダーです。CData Connect AI と組み合わせることで、ビジネスアプリケーションから API のデータに即座にアクセスできるようになります。この記事では、Connect AI を使用して your API に接続し、Appsmith で API のデータから基本的なアプリケーションを作成するプロセスを説明します。

CData Connect AI は、your API への純粋なSQL Server のクラウドtoクラウドインターフェースを提供し、Appsmith 内からライブ API のデータを直接使用してビジネスアプリケーションを作成できます。ネイティブデータベースへのデータレプリケーションは必要ありません。アプリケーションを構築する際、Appsmith はデータを収集するためのSQL クエリを生成します。CData Connect AI は、最適化されたデータ処理機能により、フィルタやJOIN を含むすべてのサポートされるSQL オペレーションを your API に直接送信します。これにより、サーバーサイドの処理を活用して、リクエストされた API のデータを迅速に取得できます。

Appsmith 用に your API への接続を構成

Appsmith から your API への接続は、CData Connect AI を介して行います。Appsmith から API のデータを操作するには、まず your API 接続を作成して構成します。

Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

Add Connection パネルから「API」を選択します

your 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"
Save & Test をクリックします
Add your API Connection ページのPermissions タブに移動し、User-based permissions を更新します。

パーソナルアクセストークンの追加

REST API、OData API、またはVirtual SQL Server を介してConnect AI に接続する場合、パーソナルアクセストークン（PAT）を使用してConnect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別のPAT を作成することをお勧めします。

Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
設定ページで、Access Tokens セクションに移動し、 Create PAT をクリックします。
PAT に名前を付けて、Create をクリックします。
パーソナルアクセストークンは作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。

接続が構成され、PAT が生成されたので、Appsmith から API のデータに接続する準備が整いました。

ライブ API のデータからAppsmith アプリケーションを作成

Appsmith からCData Connect AI Virtual SQL Server への接続を確立するには、以下の手順に従います。

Appsmith で your API に接続

Appsmith インスタンスにログインし、新しいアプリケーションを作成します。
新しいアプリケーションで、Data ページを開き、Bring your data を選択します。
このページで、Microsoft SQL Server を検索し、データソースとして選択します。
新しいデータソースの名前を入力し、以下の接続設定を入力します。
- Host address: tds.cdata.com
- Port: 14333
- Database name: 接続するCData Connect AI データソースの接続名を入力します（例：API1）。
- Username: CData Connect AI のユーザー名を入力します。これはCData Connect AI インターフェースの右上に表示されます。例：[email protected]。
- Password: 先ほど生成したPAT を入力します。
Test configuration をクリックして接続が成功したことを確認し、Save をクリックしてデータソースを保存します。

新しいクエリを作成

データソースへの接続を構成したら、SQL クエリを追加してデータソースから実際にデータを取得します。

新しいデータソースの画面で、New Query をクリックします。
クエリエディタが開き、データを選択するSQL クエリを入力できます。SQL クエリの指定については、CData Connect AI のExplorer を使用して、SQL クエリと取得するデータをプレビューできます。
SQL クエリを作成したら、Appsmith のクエリエディタに戻り、SQL クエリを入力してRun をクリックします。
クエリが正常に実行されたら、あとは取得したデータを表示するためのページをセットアップするだけです。