WCF アプリケーションで HubSpot のデータ の OData サービスを公開

CData ADO.NET Provider for HubSpot を使用すると、Windows Communication Foundation（WCF）フレームワークを活用してサービス指向アプリケーションを素早く開発し、HubSpot のデータを OData コンシューマーに提供できます。この記事では、接続用の Entity Data Model を作成し、WCF Data Service を構成して OData サービスを公開する方法を解説します。公開したフィードは、Power Pivot や CData ADO.NET Provider for OData を使用するアプリケーションなど、さまざまな OData クライアントから利用できます。

はじめに

---

OData サービスの作成

以下の手順で、OData 経由でHubSpot のデータへの接続を提供する WCF サービスアプリケーションを作成します。

1. Visual Studio を開き、新しいプロジェクトを作成します。WCF Service Application テンプレートを選択します。
2. 自動生成された IService.cs と Service1.svc を削除します。
3. Entity Framework 6 をインストールします：

   Visual Studio のパッケージマネージャーコンソールを使用して、最新バージョンの Entity Framework をインストールします。以下のコマンドを実行すると、Entity Framework が自動的にダウンロード・インストールされます。

   Install-Package EntityFramework

4. Entity Framework プロバイダーを登録します：
   1. App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。

      <configuration>
      ...
      <entityFramework>
        <providers>
          ...
          <provider invariantName="System.Data.CData.HubSpot" type="System.Data.CData.HubSpot.HubSpotProviderServices, System.Data.CData.HubSpot.Entities.EF6" />
        </providers>
      </entityFramework>
      </configuration>

   2. インストールディレクトリの lib/4.0 にある System.Data.CData.HubSpot.Entities.dll への参照を追加します。
   3. プロジェクトをビルドして、EF6 のセットアップを完了します。
5. Project -> Add New Item -> ADO.NET Entity Data Model をクリックします。
6. 表示される Entity Data Model ウィザードで、'EF Designer from Database' オプションを選択します。
7. Choose Your Connection ダイアログが表示されたら、New Connection をクリックします。

8. Connection properties ダイアログで、CData HubSpot Data Source を選択し、必要な認証情報を入力します。

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

   HubSpot はOAuth 認証 およびPrivateAppToken ベース認証をサポートします。

   OAuth

   HubSpot は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーションまたはヘッドレスマシンから簡単に接続できます。 Web アプリケーションから接続するには、カスタムOAuth アプリケーションを作成する必要があります。 OAuth 経由で接続するには、すべての認証フローでAuthScheme をOAuth に設定します。 ヘルプドキュメントでは、利用可能なOAuth フローでのHubSpot への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、「カスタムOAuth アプリケーションの作成」セクション を参照してください。

   また、PrivateAppToken ベース認証についてはヘルプドキュメントの「接続の確立」セクションを参照してください。

   
9. OData クライアントからアクセスさせたい HubSpot のテーブルとビューを選択します。
10. Project -> Add New Item -> WCF Data Service をクリックします。

11. データソースクラスを指定し、新しい WCF Data Service へのアクセスを構成します。以下の例では、エンティティの Access Rule が All に設定されています。これは、すべてのユーザーがデータの読み取りと変更を行えることを意味します。

      
    using System;
    using System.Collections.Generic;
    using System.Data.Services;
    using System.Data.Services.Common;
    using System.Linq;
    using System.ServiceModel.Web;
    using System.Web;
    
    namespace HubSpotService{
      public class HubSpotDataService : DataService<HubSpotEntities> {
        public static void InitializeService(DataServiceConfiguration config) {
          config.SetEntitySetAccessRule("*", EntitySetRights.All);
          config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3;
        }
      }
    }
    	

12. プロジェクトを実行します。これで、OData 対応アプリケーションから Salesforce データにアクセスし、変更を反映できるようになります。ブラウザでフィードにアクセスできます。フィードは次のように表示されます：

Power Pivot から OData サービスを利用する

これで、任意の OData クライアント（例：Excel Power Pivot）からサービスを利用できます。

1. Excel を開き、Power Pivot Window ボタンをクリックします。
2. 新しいポップアップが表示されます。From Data Feeds オプションを選択します。
3. 表示される Table Import Wizard で、OData URL を入力します（例：http://localhost:12449/HubSpotDataService.svc/）。
4. OData サービスへの接続後、ウィンドウ下部の Next ボタンをクリックします。
5. ウィザードの次のウィンドウに、利用可能なテーブルの一覧が表示されます。インポートするテーブルを選択し、Finish をクリックします。
6. Close をクリックして、Power Pivot にデータをインポートします。