ODBC を介してNode.js からCapsuleCRM のデータをクエリ
Node.js はブラウザ上以外でJavaScript コードを使用できるJavaScript ランタイム環境です。CData ODBC Driver for API を使用すれば、Node.js アプリとスクリプトから、リアルタイムCapsuleCRM のデータにアクセスできます。この記事ではnode-odbc のインストールと、リアルタイムCapsuleCRM のデータへのアクセスが可能な、シンプルなNode.js アプリケーションを作成するために必要なツールについて説明します。
ビルトインの最適化されたデータ処理により、CData ODBC Driver は比類のないパフォーマンスで、Node.js のリアルタイムCapsuleCRM のデータとやりとりできます。Node.js からCapsuleCRM に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をCapsuleCRM に直接プッシュし、組み込まれたSQL エンジンを利用してサポートされていない操作(主にSQL 関数とJOIN 操作)をクライアント側で処理します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- CapsuleCRM をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにCapsuleCRM のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてCapsuleCRM の接続を設定、2.Node.js 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとCapsuleCRM への接続設定
まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
必要な接続プロパティの値が未入力の場合には、データソース名(DSN)で入力します。組み込みのMicrosoft ODBC Data Source Administrator を使用し、DSN を構成できます。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、ヘルプドキュメントの「はじめに」を参照してください。
まず、Profile 接続プロパティをディスク上の CapsuleCRM プロファイルの場所に設定します(例:C:\profiles\Capsulecrm.apip)。次に、ProfileSettings 接続プロパティを CapsuleCRM の接続文字列に設定します(以下を参照)。
CapsuleCRM API プロファイル設定
GitHub の認証情報を使用して https://developer.capsulecrm.com/signIn で OAuth アプリケーションを登録し、クライアント ID とクライアントシークレットを取得します。
node-odbc を構築する
CData ODBC Driver を介してCapsuleCRM に接続するには、必要なツールをインストールした後に、node-odbc を手動で構築する必要があります。
必要なツールをインストールする
以下のコマンドでは、node-odbc の構築に必要なツールをインストールします。(ツールをグローバルにインストールする-g パラメータに注意してください。)
npm i -g windows-build-tools npm i -g node-gyp
node-odbc を構築する
必要なツールをインストールしたらNode.js アプリケーションのディレクトリを作成し、Node.js スクリプトで使用するバイナリを構築するodbc をインストールします。
mkdir nodeodbc cd nodeodbc npm i -g node
Node.js からCapsuleCRM をクエリ
ODBC Driver がインストールされ、DSN が構成されて、node-odbc が構築されたら、Node.js アプリケーションからリアルタイムCapsuleCRM のデータをクエリすることができるようになります。以下のサンプルコードは、特定のDSN に接続してActivityTypes テーブルをクエリします。
myscript.js
const odbc = require('odbc');
async function queryAPI() {
const connection = await odbc.connect(`DSN=CData API Source`);
const data = await connection.query('SELECT Id, Name FROM ActivityTypes');
console.log(data);
}
queryAPI();
アプリケーションを作成したら、node を使用してスクリプトを実行します。
node myscript.js
おわりに
CData ODBC Driver for API の30日の無償評価版 をダウンロードすればNode.js でリアルタイムCapsuleCRM のデータを使用できます。ご不明な点があれば、サポートチームにお問い合わせください。