Node.js からZoho Creator のデータをクエリ



CData API Server とADO.NET Provider for ZohoCreator(もしくは250+ の他のADO.NET Providers)を使って、Zoho Creator をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたZoho Creator のデータをNode.js でリクエストする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなZoho Creator OData サービスを作成していきましょう。

Zoho Creator への接続

NodeJS からZoho Creator のデータを操作するには、まずZoho Creator への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Zoho Creator」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Zoho Creator への接続設定を行っていきましょう！

5. Zoho Creator 接続プロパティの取得・設定方法

   Zoho Creator に接続するには、Region をサーバーURL のトップレベルドメイン（TLD）に設定します。

   Zoho Creator への認証

   Zoho Creator は、データに接続する2つの方法を提供します。

   • デスクトップ経由で自分のローカルデータに接続する場合（非ブラウザ接続）は、CData が提供する組み込みOAuth アプリケーションを使用します。
   • ネットワーク経由で共有データに接続する場合（ブラウザ接続）は、カスタムOAuth アプリケーションを使用します。
   すべてのOAuth フロー（埋め込みまたはカスタム）で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。 ヘルプドキュメントでは、次の3つの一般的な認証フローでのZoho Creator への認証について詳しく説明します。
   • デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
   • Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
   • ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。
   認証方法の詳細は、ヘルプドキュメントを参照してください。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Zoho Creator 接続プロパティの取得・設定方法

Zoho Creator に接続するには、Region をサーバーURL のトップレベルドメイン（TLD）に設定します。

Zoho Creator への認証

Zoho Creator は、データに接続する2つの方法を提供します。

• デスクトップ経由で自分のローカルデータに接続する場合（非ブラウザ接続）は、CData が提供する組み込みOAuth アプリケーションを使用します。
• ネットワーク経由で共有データに接続する場合（ブラウザ接続）は、カスタムOAuth アプリケーションを使用します。

すべてのOAuth フロー（埋め込みまたはカスタム）で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。 ヘルプドキュメントでは、次の3つの一般的な認証フローでのZoho Creator への認証について詳しく説明します。

• デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
• Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
• ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

認証方法の詳細は、ヘルプドキュメントを参照してください。

API Server のユーザー設定

次に、API Server 経由でZoho Creator にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Zoho Creator 用のAPI エンドポイントの作成

ユーザーを作成したら、Zoho Creator のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でZoho Creator への接続を設定してユーザーを作成し、API Server でZoho Creator データのAPI を追加しました。これで、OData 形式のZoho Creator データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Node.js からZoho Creator OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはLeave_Types データに対して認証されたリクエストを行います。 以下のURL の例では、Leave_Type カラムの値がSick のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Leave_Types?$filter=" + encodeURIComponent("Leave_Type eq 'Sick'"),
  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);
});