Import Adobe Commerce Data into Microsoft Power Query



The CData API Server offers standards-based Web service endpoints that allow a variety of applications to access Adobe Commerce data. In this article, you will use the OData format to import Adobe Commerce data into Microsoft Power Query.

The API Server, when paired with the ADO.NET Provider for Adobe Commerce (or any of 200+ other ADO.NET Providers), enables you to use Web services to connect to and query Adobe Commerce data. This article details how to import an OData feed of Adobe Commerce data into Microsoft Power Query.

Set Up the API Server

Follow the steps below to begin producing secure Adobe Commerce OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Adobe Commerce

After you deploy the API Server and the ADO.NET Provider for Adobe Commerce, provide authentication values and other connection properties needed to connect to Adobe Commerce by clicking Settings -> Connections and adding a new connection in the API Server administration console.

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

  • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

  • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

    If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

You can then choose the Adobe Commerce entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Connect to Adobe Commerce Data from Power Query

Follow the steps below to import tables that can be refreshed on demand:

  1. Configure the API Server to use a version of the OData protocol that is recognized by Power Query. In the API Server administration console, click Settings -> Server and change the value of the Default Version property to 3.0.
  2. From the ribbon in Excel, click Power Query -> From Other Data Sources -> From OData Feed, and enter the OData URL:

    https://your-server:8032/api.rsc
  3. In the next step of the wizard, define authentication credentials and set privacy levels. Select Basic authentication and enter the credentials for a user authorized to make requests. Specify the Username field and enter the user's authtoken in the Password field.

    To change the authentication scheme that Power Query will use, click Power Query -> Data Source Settings. Select the OData feed from the list and then click Edit Credential. Select the privacy level from the menu on the Data Source Settings page.

  4. You can now access Adobe Commerce data in Power Query. In the Navigator expand the node for the OData feed, right-click a table, and click Edit to open the Query Editor. This will display the table data.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server