Node.js からSAP SuccessFactors LMS のデータをクエリ
CData API Server とADO.NET Provider for SAPSuccessFactorsLMS(もしくは240+ の他のADO.NET Providers)を使って、SAP SuccessFactors LMS をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたSAP SuccessFactors LMS のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSAP SuccessFactors LMS OData サービスを作成していきましょう。
SAP SuccessFactors LMS への接続
NodeJS からSAP SuccessFactors LMS のデータを操作するには、まずSAP SuccessFactors LMS への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SAP SuccessFactors LMS」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、SAP SuccessFactors LMS への接続設定を行っていきましょう!
-
SAP SuccessFactors LMS は OAuth 認証を使用します。接続する前に、SAP SuccessFactors LMS アカウントに紐づけた OAuth アプリケーションを構成する必要があります。
接続するには、以下のプロパティを設定してください。
- User: SAP SuccessFactors LMS のユーザー名。
- CompanyId: SAP SuccessFactors の会社 ID。
- Url: SAP SuccessFactors API の URL(例: https://api4.successfactors.com)。
- OAuthClientId: カスタム OAuth アプリケーション登録時に割り当てられたクライアント ID。
- OAuthClientSecret: カスタム OAuth アプリケーション登録時に割り当てられたクライアントシークレット。
カスタム OAuth アプリの作成と OAuth の使用方法については、ヘルプドキュメントの「はじめに」を参照してください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
SAP SuccessFactors LMS は OAuth 認証を使用します。接続する前に、SAP SuccessFactors LMS アカウントに紐づけた OAuth アプリケーションを構成する必要があります。
接続するには、以下のプロパティを設定してください。
- User: SAP SuccessFactors LMS のユーザー名。
- CompanyId: SAP SuccessFactors の会社 ID。
- Url: SAP SuccessFactors API の URL(例: https://api4.successfactors.com)。
- OAuthClientId: カスタム OAuth アプリケーション登録時に割り当てられたクライアント ID。
- OAuthClientSecret: カスタム OAuth アプリケーション登録時に割り当てられたクライアントシークレット。
カスタム OAuth アプリの作成と OAuth の使用方法については、ヘルプドキュメントの「はじめに」を参照してください。
API Server のユーザー設定
次に、API Server 経由でSAP SuccessFactors LMS にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
SAP SuccessFactors LMS 用のAPI エンドポイントの作成
ユーザーを作成したら、SAP SuccessFactors LMS のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でSAP SuccessFactors LMS への接続を設定してユーザーを作成し、API Server でSAP SuccessFactors LMS データのAPI を追加しました。これで、OData 形式のSAP SuccessFactors LMS データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からSAP SuccessFactors LMS OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはItems データに対して認証されたリクエストを行います。 以下のURL の例では、Active カラムの値がtrue のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Items?$filter=" + encodeURIComponent("Active eq 'true'"),
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);
});