ODBC を介してNode.js からHarvest のデータをクエリ
Node.js はブラウザ上以外でJavaScript コードを使用できるJavaScript ランタイム環境です。CData ODBC Driver for API を使用すれば、Node.js アプリとスクリプトから、リアルタイムHarvest のデータにアクセスできます。この記事ではnode-odbc のインストールと、リアルタイムHarvest のデータへのアクセスが可能な、シンプルなNode.js アプリケーションを作成するために必要なツールについて説明します。
ビルトインの最適化されたデータ処理により、CData ODBC Driver は比類のないパフォーマンスで、Node.js のリアルタイムHarvest のデータとやりとりできます。Node.js からHarvest に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をHarvest に直接プッシュし、組み込まれたSQL エンジンを利用してサポートされていない操作（主にSQL 関数とJOIN 操作）をクライアント側で処理します。
CData ODBC ドライバとは？
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- Harvest をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにHarvest のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてHarvest の接続を設定、2.Node.js 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとHarvest への接続設定
まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
必要な接続プロパティの値が未入力の場合には、データソース名（DSN）で入力します。組み込みのMicrosoft ODBC Data Source Administrator を使用し、DSN を構成できます。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、ヘルプドキュメントの「はじめに」を参照してください。
まず、Profile 接続プロパティをディスク上のHarvest プロファイルの場所に設定します（例：C:\profiles\Harvest.apip）。次に、ProfileSettings 接続プロパティをHarvest の接続文字列に設定します（以下を参照）。
Harvest API プロファイル設定
Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。
トークン認証の使用
トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。
OAuth 認証の使用
まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。
以下の接続プロパティを設定すると、接続できるようになります。
- ProfileSettings：ProfileSettings でAccountId を設定します。
- AuthScheme：OAuth に設定します。
- OAuthClientId：アプリ設定で指定したclient ID に設定します。
- OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
- CallbackURL：アプリ設定で指定したRedirect URI に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。
node-odbc を構築する
CData ODBC Driver を介してHarvest に接続するには、必要なツールをインストールした後に、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 からHarvest をクエリ
ODBC Driver がインストールされ、DSN が構成されて、node-odbc が構築されたら、Node.js アプリケーションからリアルタイムHarvest のデータをクエリすることができるようになります。以下のサンプルコードは、特定のDSN に接続してInvoices テーブルをクエリします。
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, ClientName FROM Invoices');
console.log(data);
}
queryAPI();
アプリケーションを作成したら、node を使用してスクリプトを実行します。
node myscript.js
おわりに
CData ODBC Driver for API の30日の無償評価版 をダウンロードすればNode.js でリアルタイムHarvest のデータを使用できます。ご不明な点があれば、サポートチームにお問い合わせください。