WordPress REST API Basic Authorization not working

[fairking]

Hi All,

I am trying to utilize the WordPress REST API with Basic Auth using application password:

var wp_api = new WooCommerceNET.RestAPI("https://my-site/wp-json/wp/v2/", "admin", "xxxx xxxx xxxx xxxx xxxx xxxx");
wp_api.Debug = true;
var wp_client = new WooCommerce.NET.WordPress.v2.WPObject(wp_api);

var result = wp_client.Categories.GetAll().GetAwaiter().GetResult(); // Error occurs here

And receiving the following error:

System.Exception
  HResult=0x80131500
  Message=There was an error deserializing the object of type System.Collections.Generic.List`1[[WooCommerce.NET.WordPress.v2.Categories, WooCommerce.NET, Version=0.8.6.0, Culture=neutral, PublicKeyToken=null]]. Encountered unexpected character 'o'.

oauth_token and oauth_token_secret parameters are required when using WordPress REST API.
  Source=WooCommerce.NET
  StackTrace:
   at WooCommerceNET.RestAPI.DeserializeJSon[T](String jsonString)
   at WooCommerceNET.Base.WCItem`1.<GetAll>d__10.MoveNext()
   at MyApp.Form1.btnUpload_Click(Object sender, EventArgs e) in C:\Users\Admin\source\repos\MyApp\MyApp\Form1.cs:line 80
   at System.Windows.Forms.Button.OnClick(EventArgs e)
   at System.Windows.Forms.Button.OnMouseUp(MouseEventArgs mevent)
   at System.Windows.Forms.Control.WmMouseUp(Message& m, MouseButtons button, Int32 clicks)
   at System.Windows.Forms.Control.WndProc(Message& m)
   at System.Windows.Forms.ButtonBase.WndProc(Message& m)
   at System.Windows.Forms.NativeWindow.Callback(HWND hWnd, MessageId msg, WPARAM wparam, LPARAM lparam)

However the WC REST API works as expected:

var wc_api = new WooCommerceNET.RestAPI("https://my-site/wp-json/wc/v3/", "admin", "xxxx xxxx xxxx xxxx xxxx xxxx");
wc_api.Debug = true;
var wc_client = new WooCommerceNET.WooCommerce.v3.WCObject(wc_api);

var result = wc_client.Product.GetAll().GetAwaiter().GetResult(); // Works fine here

Does anyone know what is wrong here? Is there anything needs to be configured?

Reference: Basic Authentication with Application Passwords

[fairking]

Ok, looks like something broken in the WooCommerce.NET API Client itself.

My fix was to set the version to V3 as a workaround:

var wp_api = new WooCommerceNET.RestAPI("https://my-site/wp-json/wp/v2/", "admin", "xxxx xxxx xxxx xxxx xxxx xxxx");

// Fix the version number, so we can still use Basic Authentication in Wordpress API
wp_api.GetType()
    .GetProperty(nameof(wp_api.Version), BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)
    .SetValue(wp_api, WooCommerceNET.APIVersion.Version3);

After that the API started working as expected. Thanks guys for the package 👍

[fairking]

B.T.W you can also override the rest client by doing the following:

    public class MyWpClient : RestAPI
    {
        public MyWpClient(string url, string key, string secret, bool authorizedHeader = true, Func<string, string> jsonSerializeFilter = null, Func<string, string> jsonDeserializeFilter = null, Action<HttpWebRequest> requestFilter = null, Action<HttpWebResponse> responseFilter = null) 
            : base(url, key, secret, authorizedHeader, jsonSerializeFilter, jsonDeserializeFilter, requestFilter, responseFilter)
        {
            if (url.EndsWith("/wp-json/wp/v2/"))
            {
                this.GetType()
                    .GetProperty(nameof(this.Version), BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)
                    .SetValue(this, WooCommerceNET.APIVersion.Version3);
            }
        }
    }

and the use your client instead:

var wp_api = new MyWpClient("https://my-site/wp-json/wp/v2/", "admin", "your app password");

[fairking]

Because there is no v3 api for the WP (https://developer.wordpress.org/rest-api/reference/).

…

________________________________ From: richardaubin ***@***.***> Sent: Thursday, April 3, 2025 1:54 AM To: XiaoFaye/WooCommerce.NET ***@***.***> Cc: Den ***@***.***>; State change ***@***.***> Subject: Re: [XiaoFaye/WooCommerce.NET] WordPress REST API Basic Authorization not working (Discussion #783) Why are you not using the v3 api? — Reply to this email directly, view it on GitHub<#783 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ADG62TZTDPRO76CHO5QJNKT2XSBFJAVCNFSM6AAAAABPNMQGJOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTENZQG43DMNI>. You are receiving this because you modified the open/close state.Message ID: ***@***.***>

[richardaubin]

I didn't read the subject correctly. My bad.