Excel Add-In for WooCommerce

Build 23.0.8839

Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From WooCommerce connection/s to launch the CData Query window. To setup a new connection, you will have to click the New WooCommerce Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to WooCommerce

In order to connect to WooCommerce, you also must specify the service instance's URL:

  • Url: The base URL of the WooCommerce instance to connect to. For example, http://localhost/woocommerce/.

Authenticating to WooCommerce

WooCommerce supports Basic authentication, "one-legged" OAuth1.0 authentication, and standard OAuth2.0 authentication.

Basic Authentication

Certain plugins or servers can interfere with the Authorization header if not configured properly. In those cases, users can employ Basic authentication to validate their credentials. In Basic authentication, the user provides the WooCommerce consumer_key as the user, and the WooCommerce consumer_secret as the password. These credentials are then sent as query parameters with each request.

To authenticate using Basic authentication, specify these properties:

  • AuthScheme: Basic.
  • ConsumerKey: The WooCommerce consumer key(User).
  • ConsumerSecret: The WooCommerce consumer secret(Password).

"One-Legged" Authentication

One-legged (OAuth 1.0) authentication uses credentials generated from the WooCommerce setttings page. These are not the same as the credentials generated using the WooCommerce OAuth 2.0 plugin.

To authenticate using one-legged authentication, specify these properties:

  • AuthScheme: OAuthOneLegged.
  • ConsumerKey
  • ConsumerSecret

OAuth 2.0 Authentication

To enable OAuth 2.0 authentication from all OAuth flows, you must install the WooCommerce OAuth2 Plugin, create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to WooCommerce from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in WooCommerce, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

  • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret that was assigned when you registered your application.
  • CallbackURL: The redirect URI that was defined when you registered your application.

When you connect, the add-in opens WooCommerce's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the add-in refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the add-in automatically refresh the OAuth access token:

  1. Before connecting to data for the first time, set these connection properties:
    • InitiateOAuth: REFRESH.
    • OAuthClientId: The client Id in your application settings.
    • OAuthClientSecret: The client secret in your application settings.
    • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation: The path where you want the add-in to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set:
    • InitiateOAuth
    • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set these connection properties:

    • OAuthClientId: The Client Id in your application settings.
    • OAuthClientSecret: The Client Secret in your application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to WooCommerce you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839