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

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

API Server の設定

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

Vercel への接続

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

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

5. API キー認証の設定

   Vercel は Bearer トークン認証を使用します。API キーとして、パーソナルアクセストークンまたは OAuth アクセストークンのいずれかを使用できます。

   パーソナルアクセストークンを取得するには、以下のステップで進めます：

   1. https://vercel.com/ で Vercel アカウントにログインします
   2. Account Settings > Tokens に移動します。
   3. Create Token をクリックし、名前と有効期限を入力して Create をクリックします。
   4. 生成されたトークンをコピーします（一度しか表示されません）。

   トークンを取得したら、以下の接続プロパティを設定します：

   • AuthScheme：APIKey に設定します。
   • APIKey：Vercel のパーソナルアクセストークンまたは OAuth アクセストークンに設定します。

   接続文字列の例

   Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
   

   チームの利用

   Vercel のリソースの多くは、チームにスコープされています。すべてのリクエストを特定のチームにスコープするには、TeamId 接続プロパティにチームの ID を設定します。チーム ID は、Teams テーブルをクエリするか、Vercel ダッシュボードで確認できます。あるいは、サポートされている場合は SQL クエリの WHERE 句で TeamId を指定することもできます。

   Vercel への接続

   認証を設定すると、Vercel に接続して、Projects、Deployments、Teams、Domains などの利用可能なテーブルからデータをクエリできます。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

API キー認証の設定

Vercel は Bearer トークン認証を使用します。API キーとして、パーソナルアクセストークンまたは OAuth アクセストークンのいずれかを使用できます。

パーソナルアクセストークンを取得するには、以下のステップで進めます：

1. https://vercel.com/ で Vercel アカウントにログインします
2. Account Settings > Tokens に移動します。
3. Create Token をクリックし、名前と有効期限を入力して Create をクリックします。
4. 生成されたトークンをコピーします（一度しか表示されません）。

トークンを取得したら、以下の接続プロパティを設定します：

• AuthScheme：APIKey に設定します。
• APIKey：Vercel のパーソナルアクセストークンまたは OAuth アクセストークンに設定します。

接続文字列の例

Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;

チームの利用

Vercel のリソースの多くは、チームにスコープされています。すべてのリクエストを特定のチームにスコープするには、TeamId 接続プロパティにチームの ID を設定します。チーム ID は、Teams テーブルをクエリするか、Vercel ダッシュボードで確認できます。あるいは、サポートされている場合は SQL クエリの WHERE 句で TeamId を指定することもできます。

Vercel への接続

認証を設定すると、Vercel に接続して、Projects、Deployments、Teams、Domains などの利用可能なテーブルからデータをクエリできます。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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