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

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

API Server の設定

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

Miro への接続

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

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

5. API キー認証の設定

   Miro は、アクセストークンを使った API キー認証を使用します。アクセストークンを生成するには、以下のステップで進めます：

   1. Miro アカウントにログインします
   2. Settings > Your apps に移動します
   3. 「Create new app」をクリックするか、既存のアプリを選択します
   4. 必要な権限を設定します（例：boards:read、teams:read）
   5. アプリをインストールしてアクセストークンを生成します
   6. 生成されたアクセストークンをコピーします（一度しか表示されません）

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

   • AuthScheme：APIKey に設定します。
   • APIKey：アクセストークンに設定します。

   Miro への接続

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

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

API キー認証の設定

Miro は、アクセストークンを使った API キー認証を使用します。アクセストークンを生成するには、以下のステップで進めます：

1. Miro アカウントにログインします
2. Settings > Your apps に移動します
3. 「Create new app」をクリックするか、既存のアプリを選択します
4. 必要な権限を設定します（例：boards:read、teams:read）
5. アプリをインストールしてアクセストークンを生成します
6. 生成されたアクセストークンをコピーします（一度しか表示されません）

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

• AuthScheme：APIKey に設定します。
• APIKey：アクセストークンに設定します。

Miro への接続

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

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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