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

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server は、データを外部に公開します。CData API Server のOData エンドポイントを使って、Node.js からOutlook へのCRUD クエリを実行します。



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

API Server の設定

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

Outlook への接続

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

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

    Microsoft Graph API は認証に OAuth 2.0 を使用します。OAuth 認証情報(Client ID と Client Secret)を取得するには、Microsoft Azure Portal でアプリケーションを登録する必要があります。

    OAuth 認証情報の取得

    1. Azure Portal にログインします。
    2. Azure Active Directory > App registrations に移動します。
    3. New registration をクリックして新しいアプリケーションを作成します。
    4. アプリケーション名を入力し、適切なアカウントの種類を選択します。
    5. Redirect URI をアプリケーションのコールバック URL に設定します(デスクトップアプリの場合は http://localhost:33333 など)。
    6. Register をクリックしてアプリケーションを作成します。
    7. アプリケーションの概要ページで Application (client) ID をコピーします。これが OAuthClientId になります。
    8. Certificates & secrets に移動して、新しいクライアントシークレットを作成します。
    9. クライアントシークレットの値をコピーします。これが OAuthClientSecret になります。
    10. API permissions に移動して、必要な Microsoft Graph API の権限を追加します:
      • Mail.Read - メールメッセージへのアクセス用
      • Contacts.Read - 連絡先へのアクセス用
      • Calendars.Read - カレンダーイベントへのアクセス用
      • Tasks.Read - To Do タスクへのアクセス用
      • offline_access - リフレッシュトークンの取得用
    11. Grant admin consent をクリックして、これらの権限を付与します。

    OAuth での接続

    以下の接続プロパティを設定して接続を確立してください:

    • AuthScheme:OAuth に設定します。
    • InitiateOAuthGETANDREFRESH に設定します。CData API Profile for Outlook が OAuth プロセスを自動的に進め、アクセストークンを取得します。
    • OAuthClientId:Azure Portal の Application (client) ID に設定します。
    • OAuthClientSecret:Azure Portal のクライアントシークレットの値に設定します。
    • TenantId:Azure AD のテナント識別子(GUID または 'contoso.onmicrosoft.com' のようなドメイン名)に設定します。
    • CallbackURL:アプリ登録で指定したリダイレクト URI に設定します(デスクトップアプリの場合は http://localhost:33333 など)。

    接続文字列の例

    Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;
    
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

OAuth 認証の設定

Microsoft Graph API は認証に OAuth 2.0 を使用します。OAuth 認証情報(Client ID と Client Secret)を取得するには、Microsoft Azure Portal でアプリケーションを登録する必要があります。

OAuth 認証情報の取得

  1. Azure Portal にログインします。
  2. Azure Active Directory > App registrations に移動します。
  3. New registration をクリックして新しいアプリケーションを作成します。
  4. アプリケーション名を入力し、適切なアカウントの種類を選択します。
  5. Redirect URI をアプリケーションのコールバック URL に設定します(デスクトップアプリの場合は http://localhost:33333 など)。
  6. Register をクリックしてアプリケーションを作成します。
  7. アプリケーションの概要ページで Application (client) ID をコピーします。これが OAuthClientId になります。
  8. Certificates & secrets に移動して、新しいクライアントシークレットを作成します。
  9. クライアントシークレットの値をコピーします。これが OAuthClientSecret になります。
  10. API permissions に移動して、必要な Microsoft Graph API の権限を追加します:
    • Mail.Read - メールメッセージへのアクセス用
    • Contacts.Read - 連絡先へのアクセス用
    • Calendars.Read - カレンダーイベントへのアクセス用
    • Tasks.Read - To Do タスクへのアクセス用
    • offline_access - リフレッシュトークンの取得用
  11. Grant admin consent をクリックして、これらの権限を付与します。

OAuth での接続

以下の接続プロパティを設定して接続を確立してください:

  • AuthScheme:OAuth に設定します。
  • InitiateOAuthGETANDREFRESH に設定します。CData API Profile for Outlook が OAuth プロセスを自動的に進め、アクセストークンを取得します。
  • OAuthClientId:Azure Portal の Application (client) ID に設定します。
  • OAuthClientSecret:Azure Portal のクライアントシークレットの値に設定します。
  • TenantId:Azure AD のテナント識別子(GUID または 'contoso.onmicrosoft.com' のようなドメイン名)に設定します。
  • CallbackURL:アプリ登録で指定したリダイレクト URI に設定します(デスクトップアプリの場合は http://localhost:33333 など)。

接続文字列の例

Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

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

はじめる準備はできましたか?

詳細はこちら、または無料トライアルにお申し込みください:

CData API Server