Node.js からZoho Books のデータをクエリ
CData API Server とADO.NET Provider for ZohoBooks(もしくは250+ の他のADO.NET Providers)を使って、Zoho Books をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたZoho Books のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなZoho Books OData サービスを作成していきましょう。
Zoho Books への接続
NodeJS からZoho Books のデータを操作するには、まずZoho Books への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Zoho Books」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Zoho Books への接続設定を行っていきましょう！
-
Zoho Books 接続プロパティの取得・設定方法
以下の接続プロパティを使用して、取得されるZoho Books データを正確に絞り込むことができます。
- Region：サーバーURL のトップレベルドメイン（TLD）。アカウントが米国以外のドメインにある場合は、リージョンを適宜変更してください。
- OrganizationId（オプション）：接続先の特定のZoho Books 組織に関連付けられたID。
- Organization Id の値が接続文字列で指定されていない場合、ドライバーは利用可能なすべての組織を自動的に取得し、最初のOrganization Id をデフォルトとして選択します。
Zoho Books への認証
Zoho Books はOAuth 認証標準を使用します。詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Zoho Books 接続プロパティの取得・設定方法
以下の接続プロパティを使用して、取得されるZoho Books データを正確に絞り込むことができます。
- Region：サーバーURL のトップレベルドメイン（TLD）。アカウントが米国以外のドメインにある場合は、リージョンを適宜変更してください。
- OrganizationId（オプション）：接続先の特定のZoho Books 組織に関連付けられたID。
- Organization Id の値が接続文字列で指定されていない場合、ドライバーは利用可能なすべての組織を自動的に取得し、最初のOrganization Id をデフォルトとして選択します。
Zoho Books への認証
Zoho Books はOAuth 認証標準を使用します。詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。
API Server のユーザー設定
次に、API Server 経由でZoho Books にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Zoho Books 用のAPI エンドポイントの作成
ユーザーを作成したら、Zoho Books のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でZoho Books への接続を設定してユーザーを作成し、API Server でZoho Books データのAPI を追加しました。これで、OData 形式のZoho Books データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からZoho Books OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはINVOICES データに対して認証されたリクエストを行います。 以下のURL の例では、CustomerName カラムの値がNewTech Industries のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/INVOICES?$filter=" + encodeURIComponent("CustomerName eq 'NewTech Industries'"),
auth:'MyUser:MyAuthtoken'
},
function(res) {
var body = '';
res.on('data', function(chunk) {
body += chunk;
});
res.on('end', function() {
console.log(body);
var jsonData = JSON.parse(body);
});
}).on('error', function(e) {
console.log("Error: ", e);
});