Provide OData Services of Magento Data from a WCF Application

The CData ADO.NET Provider for Magento enables you to use the Windows Communication Foundation (WCF) framework to rapidly develop service-oriented applications that provide Magento data to OData consumers. This article shows how to create an entity data model to provide the underlying connectivity to the Magento data, as well as how to create a WCF Data Service to expose the OData service. You can then consume the feed with any OData client, for example, Power Pivot or an application that uses the CData ADO.NET Provider for OData.

Create the OData Service

Follow the steps below to create a WCF service application that will provide connectivity to Magento data via OData.

1. Open Visual Studio and create a new project. Select the WCF Service Application template.
2. Delete the autogenerated IService.cs and Service1.svc.
3. Click Project -> Add New Item -> ADO.NET Entity Data Model.
4. In the Entity Data Model wizard that is displayed, select the 'EF Designer from Database' option.
5. In the resulting Choose Your Connection dialog, click New Connection.

6. In the Connection properties dialog, select the CData Magento Data Source and enter the necessary credentials. A typical connection string is below:

   OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;

   Magento はOAuth 1 認証標準を使用します。Magento REST API に接続するには、Magento システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

   また、Magento システムへのURL を提供する必要があります。URL は、Magento REST API を顧客として使用しているか管理者として使用しているかによって異なります。

   • Customer: Magento を顧客として使用するには、事前にMagento のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをMagento システムのエンドポイントに設定します。

   • Administrator: Magento を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。

     このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

   See the help documentation for guides to connecting in Visual Studio.

7. Select Magento tables and views that you want OData clients to access.
8. Click Project -> Add New Item -> WCF Data Service.

9. Specify the data source class and configure access to the new WCF Data Service. In the example below, the Access Rule for the entities is set to All. This means that any user will be able to read and modify data.

   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 MagentoService{ public class MagentoDataService : DataService { public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("*", EntitySetRights.All); config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3; } } }
10. Run the project. Applications that support OData can now access the Salesforce data and reflect any changes. You can access the feed in your browser. The feed will resemble the following:

Consume the OData Service from Power Pivot

You can now use the service from any OData client; for example, Excel Power Pivot.

1. Open Excel and click on the Power Pivot Window button.
2. A new pop-up will appear. Select the option From Data Feeds.
3. In the resulting Table Import Wizard, enter the OData URL. For example, http://localhost:12449/MagentoDataService.svc/.
4. After connecting to the OData service, click the Next button at the bottom of the window.
5. A table listing of the available tables will appear in the next window of the wizard. Select which tables you want to import and click Finish.
6. Click Close to import the data in Power Pivot.