Node.js からAcumatica のデータをクエリ
CData API Server とADO.NET Provider for Acumatica(もしくは250+ の他のADO.NET Providers)を使って、Acumatica をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたAcumatica のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなAcumatica OData サービスを作成していきましょう。
Acumatica への接続
NodeJS からAcumatica のデータを操作するには、まずAcumatica への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Acumatica」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Acumatica への接続設定を行っていきましょう！
-
Acumatica 接続プロパティの取得・設定方法
Acumatica への接続
Acumatica データソースに接続するには、次の接続プロパティを指定する必要があります。
- URL：（必須）Acumatica ERP インスタンスのベースURL。例：https://domain.acumatica.com/。
- Schema：（オプション）異なるデータを含む2つのスキーマがあります。デフォルトはREST で、Acumatica REST コントラクトベースのAPI を使用し、OData スキーマはAcumatica OData API を使用します。OData スキーマはAcumatica Generic Inquiries へのクエリに使用されます。
- Company：（一部必須）会社名またはテナント名に設定。Schema がOData に設定されている場合は必須です。
- EndpointVersion：（オプション）Web Services エンドポイントのバージョン。例：24.200.001。これはREST スキーマにのみ適用されます。
- EndpointName：（オプション）Web Services エンドポイントの名前。例：Default。これはREST スキーマにのみ適用されます。
Acumatica への認証
Acumatica データソースへの接続に使用できる認証方法は2つあります。Basic およびOAuth です。 Basic 認証では、AuthScheme をBasic に設定し、User とPassword をログイン資格情報に設定します。 OAuth 認証については、ヘルプドキュメントの「接続の確立」セクションにある「OAuth」を参照してください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Acumatica 接続プロパティの取得・設定方法
Acumatica への接続
Acumatica データソースに接続するには、次の接続プロパティを指定する必要があります。
- URL：（必須）Acumatica ERP インスタンスのベースURL。例：https://domain.acumatica.com/。
- Schema：（オプション）異なるデータを含む2つのスキーマがあります。デフォルトはREST で、Acumatica REST コントラクトベースのAPI を使用し、OData スキーマはAcumatica OData API を使用します。OData スキーマはAcumatica Generic Inquiries へのクエリに使用されます。
- Company：（一部必須）会社名またはテナント名に設定。Schema がOData に設定されている場合は必須です。
- EndpointVersion：（オプション）Web Services エンドポイントのバージョン。例：24.200.001。これはREST スキーマにのみ適用されます。
- EndpointName：（オプション）Web Services エンドポイントの名前。例：Default。これはREST スキーマにのみ適用されます。
Acumatica への認証
Acumatica データソースへの接続に使用できる認証方法は2つあります。Basic およびOAuth です。 Basic 認証では、AuthScheme をBasic に設定し、User とPassword をログイン資格情報に設定します。 OAuth 認証については、ヘルプドキュメントの「接続の確立」セクションにある「OAuth」を参照してください。
API Server のユーザー設定
次に、API Server 経由でAcumatica にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Acumatica 用のAPI エンドポイントの作成
ユーザーを作成したら、Acumatica のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でAcumatica への接続を設定してユーザーを作成し、API Server でAcumatica データのAPI を追加しました。これで、OData 形式のAcumatica データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からAcumatica OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはEvents データに対して認証されたリクエストを行います。 以下のURL の例では、Id カラムの値が1 のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Events?$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);
});