Axios と CData Connect AI で Zendesk に接続した Web アプリを構築
Axios は開発者が Web ブラウザや Node.js からサーバーに HTTP リクエストを送信できる JavaScript ライブラリです。CData Connect AI と組み合わせることで、Web アプリからライブZendesk のデータにアクセスできます。この記事では、Zendesk に接続し、Axios でライブZendesk のデータにアクセスできる Web アプリを構築する方法を説明します。
Axios から Zendesk に接続
Axios で Zendesk を操作するには、Connect AI から Zendesk に接続し、ユーザーにアクセス権を提供し、Zendesk のデータ 用のワークスペースを作成する必要があります。
Connect AI から Zendesk に接続
CData Connect AI はシンプルなポイントアンドクリックインターフェースでデータソースに接続できます。
- Connect AI にログインして「Sources」をクリック、次に「 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 の管理画面で以下の設定を行います。
- Token アクセスを有効にします。
- Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
その他の認証方法についてはヘルプドキュメントを参照してください。
- 「Save & Test」をクリック
-
Zendesk 接続の追加ページで「Permissions」タブに移動し、ユーザーベースのアクセス許可を設定します。
Personal Access Token の作成
REST API、OData API、または Virtual SQL Server を介して Connect AI に接続する場合、Personal Access Token(PAT)を使用して Connect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別の PAT を作成することをお勧めします。
- Connect AI アプリの右上にある歯車アイコン()をクリックして設定ページを開きます。
- 設定ページで「Access Tokens」セクションに移動し、「 Create PAT」をクリックします。
-
PAT に名前を付けて「Create」をクリックします。
- Personal Access Token は作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。
Axios 用に Zendesk エンドポイントを設定
Zendesk に接続したら、目的のテーブル用のワークスペースを作成します。
-
「Workspaces」ページに移動し、「 Add」をクリックして新しいワークスペースを作成します(または既存のワークスペースを選択)。
- 「 Add」をクリックしてワークスペースに新しいアセットを追加します。
-
Zendesk 接続(例: Zendesk1)を選択して「Next」をクリックします。
-
操作するテーブルを選択して「Confirm」をクリックします。
- ワークスペースの OData サービス URL をメモしておきます(例: https://cloud.cdata.com/api/odata/{workspace_name})。
接続、PAT、ワークスペースが設定できたので、Axios からZendesk のデータに接続する準備が整いました。
Axios ワークフローで Zendesk のデータに接続
OData プロトコルを使用して Axios から CData Connect AI への接続を確立するには、以下のステップに従います。
- Web アプリ用のプロジェクトディレクトリを作成します(例: ~/connect_cloud/)
- ターミナルを開き、プロジェクトディレクトリに移動して以下のコマンドで node プロジェクトを初期化します:
npm init -y
- 以下のコマンドでプロジェクトに Axios 依存関係をインストールします:
npm install axios
プロジェクトディレクトリに以下のコードを含む server.js ファイルを作成します。CData Connect AI のユーザー名(例: user@mydomain.com)と PAT(前提条件で作成した PAT)を指定します。また、SELECT * FROM Zendesk1.SCHEMA.Tickets のようなデータクエリも指定する必要があります。
server.js コード
const axios = require('axios') const user = 'user@mydomain.com' const pat = '***********************************'; //API エンドポイント const url = 'https://cloud.cdata.com/api/odata/{workspace_name}'; //POST リクエストで送信するデータ const data = { "query":"SELECT * FROM {workspace_name}.SCHEMA.Tickets" }; axios.post(url, data, { auth: { username: user, password: pat } }) .then(response => { const rows = response.data.results[0].rows; const schema = response.data.results[0].schema; //カラム名の配列を作成 const columnNames = schema.map(col => col.columnName); //各行をループして、カラム名と値をログ出力 rows.forEach(row => { const rowObject = {}; row.forEach((value, index) => { const columnName = columnNames[index]; rowObject[columnName] = value; }); console.log(rowObject); }) }) .catch(error => { console.error('Error:', error); });- ターミナルで以下のコマンドを実行してサーバーを起動します:
node server.js
クエリ結果が表示されます:{ ID: 1, VALUE: -2 } { ID: 2, VALUE: 1 } { ID: 11, VALUE: null } { ID: 3, VALUE: 2 } { ID: 4, VALUE: 5 } ...
クラウドアプリケーションから Zendesk のデータへの簡易アクセス
これで、Axios からライブZendesk のデータへの直接接続が確立されました。Axios のようなクラウドアプリケーションから 100 以上の SaaS、ビッグデータ、NoSQL ソースへの簡易アクセスについての詳細は、Connect AI ページを参照してください。