Node.js からQuickbase のデータをクエリ
CData API Server とADO.NET Provider for Quickbase(もしくは250+ の他のADO.NET Providers)を使って、Quickbase をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたQuickbase のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなQuickbase OData サービスを作成していきましょう。
Quickbase への接続
NodeJS からQuickbase のデータを操作するには、まずQuickbase への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Quickbase」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Quickbase への接続設定を行っていきましょう！
-
ユーザー認証方法
ユーザー資格情報で認証するには、次の接続プロパティを設定してください。
- User とPassword を設定します。
- アプリケーションがApplicationToken を必要とする場合には、指定しない場合にはエラーが発生します。 ApplicationToken は、SpecificApp > Settings > App management > App properties > Advanced settings > Security options > Manage Application Token に移動して取得できます。
ユーザートークン認証
ユーザートークンで認証するには、次の接続プロパティを設定してください。
- UserToken を設定すれば接続できます。UserToken は、Quick Base > My Preferences > My User Information > Manage User Tokens から確認できます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
ユーザー認証方法
ユーザー資格情報で認証するには、次の接続プロパティを設定してください。
- User とPassword を設定します。
- アプリケーションがApplicationToken を必要とする場合には、指定しない場合にはエラーが発生します。 ApplicationToken は、SpecificApp > Settings > App management > App properties > Advanced settings > Security options > Manage Application Token に移動して取得できます。
ユーザートークン認証
ユーザートークンで認証するには、次の接続プロパティを設定してください。
- UserToken を設定すれば接続できます。UserToken は、Quick Base > My Preferences > My User Information > Manage User Tokens から確認できます。
API Server のユーザー設定
次に、API Server 経由でQuickbase にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Quickbase 用のAPI エンドポイントの作成
ユーザーを作成したら、Quickbase のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でQuickbase への接続を設定してユーザーを作成し、API Server でQuickbase データのAPI を追加しました。これで、OData 形式のQuickbase データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からQuickbase OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはSampleTable_1 データに対して認証されたリクエストを行います。 以下のURL の例では、Column2 カラムの値が100 のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/SampleTable_1?$filter=" + encodeURIComponent("Column2 eq '100'"),
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);
});