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

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

API Server の設定

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

Airtable への接続

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

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

5. Airtable への接続

   それでは、Airtable に接続していきましょう。CData 製品は、Airtable にテーブルとビューを要求します。 Schema プロパティ（オプション）を使用すると、表示されるテーブルおよびビューを特定のベースに制限できます。 特定のベースに制限したい場合は、このプロパティを使用するスキーマの名前に設定してください。（これはAirtable のBase 名に相当します。）

   すべてのAirtable Bases に加えて、DataModelInformation という名前の静的スキーマもご利用いただけます。 このスキーマでは、Bases、Tables、Users のような静的テーブルをクエリできます。 DisplayObjectIds がTrue に設定されている場合、Schema の値は名前ではなくAirtable Base id に設定する必要があります。

   Airtableへの認証

   続いて、認証方法を設定しましょう。個人用アクセストークンまたはOAuth PKCE のいずれかを使用してAirtable に認証できます。

   個人用アクセストークン

   個人用アクセストークンをまだ生成していない場合は、以下のステップで生成してみましょう。

   1. ユーザーアカウントにログインします
   2. "https://airtable.com/create/tokens" に移動します
   3. Create new token をクリックします
   4. Scopes で、Add a scope をクリックして以下の各スコープを追加します
      • data.records:read
      • data.records:write
      • schema.bases:read
   5. Access で、トークンにアクセス権を付与するすべてのワークスペースとベースを追加します
   6. Create token をクリックしてトークンを生成します。生成されたトークンは一度しか表示されませんので、必ずコピーして保存してください

   次に、以下の設定を行います。

   • AuthScheme：PersonalAccessToken
   • Token：先ほど生成した個人用アクセストークンの値

   OAuth PKCE については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。

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

Airtable への接続

それでは、Airtable に接続していきましょう。CData 製品は、Airtable にテーブルとビューを要求します。 Schema プロパティ（オプション）を使用すると、表示されるテーブルおよびビューを特定のベースに制限できます。 特定のベースに制限したい場合は、このプロパティを使用するスキーマの名前に設定してください。（これはAirtable のBase 名に相当します。）

すべてのAirtable Bases に加えて、DataModelInformation という名前の静的スキーマもご利用いただけます。 このスキーマでは、Bases、Tables、Users のような静的テーブルをクエリできます。 DisplayObjectIds がTrue に設定されている場合、Schema の値は名前ではなくAirtable Base id に設定する必要があります。

Airtableへの認証

続いて、認証方法を設定しましょう。個人用アクセストークンまたはOAuth PKCE のいずれかを使用してAirtable に認証できます。

個人用アクセストークン

個人用アクセストークンをまだ生成していない場合は、以下のステップで生成してみましょう。

1. ユーザーアカウントにログインします
2. "https://airtable.com/create/tokens" に移動します
3. Create new token をクリックします
4. Scopes で、Add a scope をクリックして以下の各スコープを追加します
   • data.records:read
   • data.records:write
   • schema.bases:read
5. Access で、トークンにアクセス権を付与するすべてのワークスペースとベースを追加します
6. Create token をクリックしてトークンを生成します。生成されたトークンは一度しか表示されませんので、必ずコピーして保存してください

次に、以下の設定を行います。

• AuthScheme：PersonalAccessToken
• Token：先ほど生成した個人用アクセストークンの値

OAuth PKCE については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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