Node.js からMisoca のデータをクエリ
CData API Server とADO.NET Provider for API(もしくは250+ の他のADO.NET Providers)を使って、Misoca をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたMisoca のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなMisoca OData サービスを作成していきましょう。
Misoca への接続
NodeJS からMisoca のデータを操作するには、まずMisoca への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Misoca」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Misoca への接続設定を行っていきましょう!
-
まず、OAuth アプリを作成する必要があります。 https://app.misoca.jp/oauth2/applications に移動し、「新しいアプリケーションを作成する」ボタンをクリックしてください。アプリケーション名を入力し、リダイレクトURL を指定して、「登録する」をクリックします。そうすると、クライアントシークレットとクライアントID が表示されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
以下の接続プロパティを設定した後、接続の準備が整います。
- AuthScheme:OAuth に設定してください。
- OAuthClientID:アプリケーション設定で指定されたOAuth クライアントID に設定してください。
- OAuthClientSecret:アプリケーション設定で指定されたOAuth クライアントシークレットに設定してください。
- CallbackURL:アプリケーション設定で指定したリダイレクトURI に設定してください。
- InitiateOAuth:GETANDREFRESH に設定してください。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
まず、OAuth アプリを作成する必要があります。 https://app.misoca.jp/oauth2/applications に移動し、「新しいアプリケーションを作成する」ボタンをクリックしてください。アプリケーション名を入力し、リダイレクトURL を指定して、「登録する」をクリックします。そうすると、クライアントシークレットとクライアントID が表示されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
以下の接続プロパティを設定した後、接続の準備が整います。
- AuthScheme:OAuth に設定してください。
- OAuthClientID:アプリケーション設定で指定されたOAuth クライアントID に設定してください。
- OAuthClientSecret:アプリケーション設定で指定されたOAuth クライアントシークレットに設定してください。
- CallbackURL:アプリケーション設定で指定したリダイレクトURI に設定してください。
- InitiateOAuth:GETANDREFRESH に設定してください。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
API Server のユーザー設定
次に、API Server 経由でMisoca にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Misoca 用のAPI エンドポイントの作成
ユーザーを作成したら、Misoca のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でMisoca への接続を設定してユーザーを作成し、API Server でMisoca データのAPI を追加しました。これで、OData 形式のMisoca データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からMisoca OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはContacts データに対して認証されたリクエストを行います。 以下のURL の例では、Id カラムの値が1 のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Contacts?$filter=" + encodeURIComponent("Id eq '1'"),
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);
});