WCF アプリケーションで Shopify のデータ の OData サービスを公開
CData ADO.NET Provider for Shopify を使用すると、Windows Communication Foundation(WCF)フレームワークを活用してサービス指向アプリケーションを素早く開発し、Shopify のデータを OData コンシューマーに提供できます。この記事では、接続用の Entity Data Model を作成し、WCF Data Service を構成して OData サービスを公開する方法を解説します。公開したフィードは、Power Pivot や CData ADO.NET Provider for OData を使用するアプリケーションなど、さまざまな OData クライアントから利用できます。
OData サービスの作成
以下の手順で、OData 経由でShopify のデータへの接続を提供する WCF サービスアプリケーションを作成します。
- Visual Studio を開き、新しいプロジェクトを作成します。WCF Service Application テンプレートを選択します。
- 自動生成された IService.cs と Service1.svc を削除します。
- Entity Framework 6 をインストールします:
Visual Studio のパッケージマネージャーコンソールを使用して、最新バージョンの Entity Framework をインストールします。以下のコマンドを実行すると、Entity Framework が自動的にダウンロード・インストールされます。
Install-Package EntityFramework
- Entity Framework プロバイダーを登録します:
- App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。
<configuration> ... <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Shopify" type="System.Data.CData.Shopify.ShopifyProviderServices, System.Data.CData.Shopify.Entities.EF6" /> </providers> </entityFramework> </configuration> - インストールディレクトリの lib/4.0 にある System.Data.CData.Shopify.Entities.dll への参照を追加します。
- プロジェクトをビルドして、EF6 のセットアップを完了します。
- App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。
- Project -> Add New Item -> ADO.NET Entity Data Model をクリックします。
- 表示される Entity Data Model ウィザードで、'EF Designer from Database' オプションを選択します。
- Choose Your Connection ダイアログが表示されたら、New Connection をクリックします。
Connection properties ダイアログで、CData Shopify Data Source を選択し、必要な認証情報を入力します。
一般的な接続文字列は以下のとおりです:
AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。
アクセストークンによる接続
アクセストークン経由の接続には、以下の2つのステップが必要です。
- Shopify の管理画面でアクセストークンを作成
- アクセストークンを使用して認証
アクセストークンの作成
まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。
- 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
- Develop apps をクリックしてCreate an app を選択します
- Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
- Save をクリックします
- Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです:
- unauthenticated_read_content
- Save をクリックします
- API Credentials を選択します
- "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
- Admin API Access token のアクセストークンをコピーします。注意:トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください
アクセストークンによる認証
続いて、アクセストークンで認証するには、以下のプロパティを設定してください。
- AuthScheme:AccessToken に設定
- AccessToken:カスタムアプリからコピーしたアクセストークンの値に設定
OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

- OData クライアントからアクセスさせたい Shopify のテーブルとビューを選択します。

- Project -> Add New Item -> WCF Data Service をクリックします。
データソースクラスを指定し、新しい 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 ShopifyService{ public class ShopifyDataService : DataService<ShopifyEntities> { public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("*", EntitySetRights.All); config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3; } } }-
プロジェクトを実行します。これで、OData 対応アプリケーションから Salesforce データにアクセスし、変更を反映できるようになります。ブラウザでフィードにアクセスできます。フィードは次のように表示されます:
Power Pivot から OData サービスを利用する
これで、任意の OData クライアント(例:Excel Power Pivot)からサービスを利用できます。
- Excel を開き、Power Pivot Window ボタンをクリックします。
- 新しいポップアップが表示されます。From Data Feeds オプションを選択します。
- 表示される Table Import Wizard で、OData URL を入力します(例:http://localhost:12449/ShopifyDataService.svc/)。
- OData サービスへの接続後、ウィンドウ下部の Next ボタンをクリックします。
- ウィザードの次のウィンドウに、利用可能なテーブルの一覧が表示されます。インポートするテーブルを選択し、Finish をクリックします。
- Close をクリックして、Power Pivot にデータをインポートします。