Node.js からBlackbaud FE NXT のデータをクエリ

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

API Server の設定

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

Blackbaud FE NXT への接続

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

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

5. Blackbaud Financial Edge NXT はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。

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

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Blackbaud Financial Edge NXT はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。

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

API Server のユーザー設定

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

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

Blackbaud FE NXT 用のAPI エンドポイントの作成

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

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

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

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

Node.js からBlackbaud FE NXT OData フィードを利用

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

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

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