Node.js からSage X3 Cloud のデータをクエリ

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

API Server の設定

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

Sage X3 Cloud への接続

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

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

5. Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

   • URL：Sage X3 Cloud インスタンスのベース URL。
   • OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
   • OAuthClientId：OAuth アプリケーションのクライアント ID。
   • OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
   • Audience：トークンリクエストで使用する API の Audience 値。
   • XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
   • Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
   • Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

   ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

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

Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

• URL：Sage X3 Cloud インスタンスのベース URL。
• OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
• OAuthClientId：OAuth アプリケーションのクライアント ID。
• OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
• Audience：トークンリクエストで使用する API の Audience 値。
• XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
• Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
• Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

API Server のユーザー設定

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

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

Sage X3 Cloud 用のAPI エンドポイントの作成

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

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

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

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

Node.js からSage X3 Cloud OData フィードを利用

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

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

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