Node.js からShipStation のデータをクエリ

CData API Server とADO.NET Provider for ShipStation(もしくは250+ の他のADO.NET Providers)を使って、ShipStation をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたShipStation のデータをNode.js でリクエストする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなShipStation OData サービスを作成していきましょう。

ShipStation への接続

NodeJS からShipStation のデータを操作するには、まずShipStation への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「ShipStation」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、ShipStation への接続設定を行っていきましょう！

5. ShipStation 接続プロパティの取得・設定方法

   ShipStation への接続には、BASIC 認証標準を使います。

   1. ShipStation アカウントにログインします。
   2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
   3. ［アカウント］->［API 設定］をクリックします。
   4. ［API 設定］ページで、API Key とAPI Secret を書き留めます。

   ShipStation への認証

   • APIKey：［API 設定］ページのAPI Key に設定します。
   • APISecret：［API 設定］ページのSecret key に設定します。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

ShipStation 接続プロパティの取得・設定方法

ShipStation への接続には、BASIC 認証標準を使います。

1. ShipStation アカウントにログインします。
2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
3. ［アカウント］->［API 設定］をクリックします。
4. ［API 設定］ページで、API Key とAPI Secret を書き留めます。

ShipStation への認証

• APIKey：［API 設定］ページのAPI Key に設定します。
• APISecret：［API 設定］ページのSecret key に設定します。

API Server のユーザー設定

次に、API Server 経由でShipStation にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

ShipStation 用のAPI エンドポイントの作成

ユーザーを作成したら、ShipStation のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でShipStation への接続を設定してユーザーを作成し、API Server でShipStation データのAPI を追加しました。これで、OData 形式のShipStation データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Node.js からShipStation OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはTags データに対して認証されたリクエストを行います。 以下のURL の例では、CustomerId カラムの値が1368175 のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Tags?$filter=" + encodeURIComponent("CustomerId eq '1368175'"),
  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);
});