Node.js からAvalara AvaTax のデータをクエリ
CData API Server とADO.NET Provider for AvalaraAvatax(もしくは250+ の他のADO.NET Providers)を使って、Avalara AvaTax をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたAvalara AvaTax のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなAvalara AvaTax OData サービスを作成していきましょう。
Avalara AvaTax への接続
NodeJS からAvalara AvaTax のデータを操作するには、まずAvalara AvaTax への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Avalara AvaTax」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Avalara AvaTax への接続設定を行っていきましょう！
-
Basic 認証を実行する通常の方法は、次のログイン資格情報を提供することです。
- User：ユーザー名に設定します。
- Password：パスワードに設定します。
サンドボックス環境を使用している場合には、オプションで次を設定してください。
- UseSandbox：サンドボックスアカウントで認証する場合にはこれをtrue に設定します。
アカウント番号とライセンスキーを使用して認証する
または、アカウント番号とライセンスキーを使用して認証することもできます。次を使用してデータに接続します。
- AccountId：これをアカウントId に設定します。アカウントId は管理コンソールの右上端にリストされています。
- LicenseKey：これをAvalara Avatax のライセンスキーに設定します。ライセンスキーの生成は、Avalara Avatax アカウント管理者としてログインして Settings -> Reset License Key に移動して実行できます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Basic 認証を実行する通常の方法は、次のログイン資格情報を提供することです。
- User：ユーザー名に設定します。
- Password：パスワードに設定します。
サンドボックス環境を使用している場合には、オプションで次を設定してください。
- UseSandbox：サンドボックスアカウントで認証する場合にはこれをtrue に設定します。
アカウント番号とライセンスキーを使用して認証する
または、アカウント番号とライセンスキーを使用して認証することもできます。次を使用してデータに接続します。
- AccountId：これをアカウントId に設定します。アカウントId は管理コンソールの右上端にリストされています。
- LicenseKey：これをAvalara Avatax のライセンスキーに設定します。ライセンスキーの生成は、Avalara Avatax アカウント管理者としてログインして Settings -> Reset License Key に移動して実行できます。
API Server のユーザー設定
次に、API Server 経由でAvalara AvaTax にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Avalara AvaTax 用のAPI エンドポイントの作成
ユーザーを作成したら、Avalara AvaTax のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でAvalara AvaTax への接続を設定してユーザーを作成し、API Server でAvalara AvaTax データのAPI を追加しました。これで、OData 形式のAvalara AvaTax データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からAvalara AvaTax OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはTransactions データに対して認証されたリクエストを行います。 以下のURL の例では、Code カラムの値が051349 のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Transactions?$filter=" + encodeURIComponent("Code eq '051349'"),
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);
});