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

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

API Server の設定

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

Suadeo への接続

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

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

5. ドライバーはOAuth 2.0 のリソースオーナーパスワードクレデンシャル（ROPC）グラントを使用してSuadeo に認証します。認証は直接資格情報を使用して行われます。ブラウザーベースの認証フローやリフレッシュトークンはありません。

   以下の接続プロパティを設定します：

   • URL：Suadeo インスタンスのベースURL。
   • User：Suadeo のユーザー名。
   • Password：Suadeo のパスワード。
   • AuthenticationName：Suadeo インスタンスの認証設定の名前識別子。異なる環境やユースケースに対して異なる認証名を設定できます。

   接続すると、ドライバーは資格情報をSuadeo のOAuth トークンエンドポイントに送信してアクセストークンを受け取り、以降のすべてのリクエストに使用します。セッション中に必要に応じて新しいアクセストークンが自動的に取得されます。

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

ドライバーはOAuth 2.0 のリソースオーナーパスワードクレデンシャル（ROPC）グラントを使用してSuadeo に認証します。認証は直接資格情報を使用して行われます。ブラウザーベースの認証フローやリフレッシュトークンはありません。

以下の接続プロパティを設定します：

• URL：Suadeo インスタンスのベースURL。
• User：Suadeo のユーザー名。
• Password：Suadeo のパスワード。
• AuthenticationName：Suadeo インスタンスの認証設定の名前識別子。異なる環境やユースケースに対して異なる認証名を設定できます。

接続すると、ドライバーは資格情報をSuadeo のOAuth トークンエンドポイントに送信してアクセストークンを受け取り、以降のすべてのリクエストに使用します。セッション中に必要に応じて新しいアクセストークンが自動的に取得されます。

API Server のユーザー設定

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

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

Suadeo 用のAPI エンドポイントの作成

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

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

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

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

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

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

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

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