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