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

Cameron Leblanc
Technology Evangelist

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

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

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

Appsmith 用に Zendesk への接続を構成

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

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

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

Zendesk に接続するために必要な認証プロパティを入力します。
Zendesk 接続プロパティの取得・設定方法

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。
また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。
Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。
1. Token アクセスを有効にします。
2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
最後に、APIToken をアクティブなAPI トークンに設定します。

その他の認証方法についてはヘルプドキュメントを参照してください。
Save & Test をクリックします
Add Zendesk 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 から Zendesk のデータに接続する準備が整いました。

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

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

Appsmith で Zendesk に接続

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

新しいクエリを作成

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

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