ODBC を介してNode.js からXero データをクエリ

Node.js はブラウザ上以外でJavaScript コードを使用できるJavaScript ランタイム環境です。CData ODBC Driver for Xero を使用すれば、Node.js アプリとスクリプトから、ライブXero データにアクセスできます。この記事ではnode-odbc のインストールと、ライブXero データへのアクセスが可能な、シンプルなNode.js アプリケーションを作成するために必要なツールについて説明します。

ビルトインの最適化されたデータ処理により、CData ODBC Driver は比類のないパフォーマンスで、Node.js のライブXero データとやりとりできます。Node.js からXero に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をXero に直接プッシュし、組み込まれたSQL エンジンを利用してサポートされていない操作（主にSQL 関数とJOIN 操作）をクライアント側で処理します。

Xero データに接続する

必要な接続プロパティの値が未入力の場合には、データソース名（DSN）で入力します。組み込みのMicrosoft ODBC Data Source Administrator を使用し、DSN を構成できます。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、ヘルプドキュメントの「はじめに」を参照してください。

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

node-odbc を構築する

CData ODBC Driver を介してXero に接続するには、必要なツールをインストールした後に、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 からXero をクエリ

ODBC Driver がインストールされ、DSN が構成されて、node-odbc が構築されたら、Node.js アプリケーションからライブXero データをクエリすることができるようになります。以下のサンプルコードは、特定のDSN に接続してItems テーブルをクエリします。

myscript.js

const odbc = require('odbc');

async function queryXero() {
    const connection = await odbc.connect(`DSN=CData Xero Source`);
    const data = await connection.query('SELECT Name, QuantityOnHand FROM Items');
    console.log(data);
}

queryXero();

アプリケーションを作成したら、node を使用してスクリプトを実行します。

node myscript.js

CData ODBC Driver for Xero の30日の無償評価版 をダウンロードすればNode.js でライブXero データを使用できます。ご不明な点があれば、サポートチームにお問い合わせください。