Getting Started with the CData ADO.NET Provider for WooCommerce

This guide explains everything you need to work with the CData ADO.NET Provider for WooCommerce. You will learn how to install the provider, set up a connection to your WooCommerce data, and run simple commands in your .NET applications using familiar ADO.NET patterns.

Whether you are building desktop apps, web apps, or background services, the provider enables secure, high-performance connectivity to live WooCommerce data without needing to manage API details manually.

Installation and Licensing

System Requirements

• Windows: Windows 10/11 or Windows Server 2016+
• .NET Versions: .NET Framework 4.0+, .NET 6+, .NET Standard assemblies
• IDE: Visual Studio 2017 or later

Installing the ADO.NET Provider

Windows Installation

1. Download the ADO.NET provider installer from your CData account or the evaluation page.
2. Run the installer and follow the installation wizard to completion.
3. The installer registers the provider and places all assemblies in the appropriate CData installation folders.
4. You will be prompted for your license key during installation:
   XXXX-XXXX-XXXX-XXXX-XXXX
   • Note: If you are using a trial, select Trial Key instead.

Activating your License

Licensing behavior varies depending on whether you are developing with the .NET Framework or .NET Standard. Use the steps below to activate the provider in your environment.

.NET Framework (Windows)

On Windows using the .NET Framework, no extra action is required. The installer or NuGet package automatically installs your development license.

.NET Standard (Windows/Mac/Linux)

For .NET Standard platforms like .NET Core, Mono, or Xamarin, you must install a license manually before using the provider.

Using the Install-License Tool

The toolkit includes an install-license utility in the

lib/netstandard2.0

To install a trial license:

dotnet ./install-license.dll

To activate a full product license:

dotnet ./install-license.dll 

After running the tool, your development machine is licensed and ready to use the provider in .NET applications.

Runtime Licensing

When deploying applications, specify the Runtime Key (RTK) in your connection string to enable redistribution.

Common Licensing Questions

Can I use my license on multiple machines?
Yes, depending on your subscription tier. If unsure, review your order confirmation or contact [email protected].

I lost my license key. How do I retrieve it?
Email [email protected] with your order number.

Can I transfer my license to another machine?
Submit a License Transfer Request:
https://www.cdata.com/lic/transfer/

Once approved, an activation is added to your product key and the previous installation becomes invalid.

For more licensing support, visit portal.cdata.com or email [email protected].

Connection Configuration

Once installed, the next step is to configure a connection to WooCommerce. Connections are created using ADO.NET connection strings in your .NET application's code or configuration file.

Creating a connection manager

• Open Visual Studio.
• Navigate to View, select Server Explorer.
• Click Connect to Database from the left sidebar.
• In the Add Connection dialog, click Change.
• Choose CData WooCommerce data source, then click OK.

Configuring Connection Properties

WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

Connecting using one-legged OAuth 1.0 Authentication

Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

• ConsumerKey
• ConsumerSecret

Connecting using WordPress OAuth 2.0 Authentication

After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

• OAuthClientId
• OAuthClientSecret
• CallbackURL
• InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

In either case, set the Url property to the URL of the WooCommerce instance.

Test your connection

• Click Test Connection.

• Once the connection is successful, you can explore the data inside Visual Studio.

Common Connection Issues

Authentication Failed

Solution: Verify OAuth settings, client IDs, secrets, or token permissions for your WooCommerce. Contact [email protected] for assistance.

Cannot Reach Server

Solution: Check firewall, proxy, and VPN configurations. Contact [email protected] for required port information.

Table Not Found

Solution: Confirm you selected the correct schema or database when querying WooCommerce.

What's Next

Now that you have installed, licensed, and configured the ADO.NET provider, here are scenarios you can use to explore our ADO.NET tools:

Get Support

If you need assistance at any point:

• Technical Support: [email protected]
• Community Forum: CData Community Site
• Help Documentation: Installed locally and available online

FAQs

Installation and Licensing

• Do I need administrator rights to install the ADO.NET Provider?
  Yes, administrator rights are required to install components for use across Visual Studio.
• Do I need an RTK to deploy to Azure Data Factory?
  Yes. Set the RTK property in your application's connection string before publishing.

Connecting

• Can I use multiple WooCommerce accounts?
  Create separate Connection =strings for each account.
• Can I connect through a proxy?
  Yes. Configure proxy settings in the Connection string.
• How do I test my connection?
  Click Test Connection in the Connection Manager UI.

Performance & Troubleshooting

• How can I improve query performance
  Apply filters, limit row counts, and leverage server-side paging properties.
• How do I enable logging?
  Add the following to your connection manager:
  • Logfile: /path/to/logfile.log
  • Verbosity: 3

  Be prepared to securely upload the log file upon request when reaching out to [email protected] for troubleshooting analysis.

  For questions not covered in this FAQ, contact [email protected].