是否可以添加使用 WooCommerce 授权的新 API 端点？

Posted 2023-02-19

【中文标题】是否可以添加使用 WooCommerce 授权的新 API 端点？

【英文标题】：Is it possible to add a new API endpoint that uses WooCommerce's authorization?

【发布时间】：2021-06-25 23:53:38

【问题描述】：

我需要在我的 WordPress 插件中添加一个 API 端点，它将写入数据库等。我希望它由调用这个新 API 的远程系统触发。

但是，我想使用内置的 WooCommerce REST 身份验证，这里设置的身份验证：

（不，这些凭据不再起作用）。

有没有办法做到这一点？要添加一个自定义 HTTP 端点，该端点将使用来自 WooCommerce 的身份验证，然后运行一些我想要运行的任意代码？

或者有没有办法在现有的 WooCommerce API 端点上添加一个钩子以在该端点执行之前运行？我只需要一种方法来使用现有的 WooCommerce REST API 身份验证来触发我需要在我的插件中运行的一些更新。

【参考方案1】：

您可以在 Woocommerce 端点下添加路由以使用此密钥/秘密身份验证系统。

这是一个工作示例：

add_action('rest_api_init', function () 
    register_rest_route('wc', '/test', [
        'methods'  => 'GET',
        'callback' => 'my_awesome_func',
    ]);
);

function my_awesome_func(WP_REST_Request $request)


    if (is_user_logged_in() && (int)wp_get_current_user()->ID === 123) 
        //your stuff only for legged in user 123
        return new WP_REST_Response('ok', 200);
    

    return new WP_Error('unauthorized', __('You shall not pass'), [ 'status' => 401 ]); //can also use WP_REST_Response

 

这将：

在“wc”端点（woocommerce one）下添加一个新的 GET 路由，所以https://example.com/wp-json/wc/test 然后您使用“HTTP Basic auth”按照Woocommerce documentation 传递您的密钥和秘密 is_user_logged_in() 和wp_get_current_user() 的结果将取决于密钥/密码的正确组合。如果正确，关联用户将像 Wordpress 一样被“认证”。 如果组合正确，你会得到[true, WP_user_object]，如果不正确，你会得到[false, Empty_user_object]。 如果正确的密钥和不正确的秘密，将抛出 401（不是我的示例中的那个，woocommerce 的另一个 401。在这种情况下没有达到 my_awesome_func()。我相信这就像 wp-login，自定义错误消息时正确的登录名（密钥），很好^^'）

然后您需要按照您的规则保护您的路线：

检查用户是否像if(!is_user_logged_in()) return false一样登录 检查用户 ID wp_get_current_user()->ID 按您的角色/权限系统检查 现在您有了用户 ID，您可以用它做您想做的事 使用WP_REST_Request $request 参数来处理GET 或POST HTTP 参数。

所以它可能看起来像：

add_action('rest_api_init', function () 
    register_rest_route('wc', '/test', [
        'methods'  => 'GET',
        'callback' => 'my_awesome_func',
    ]);
);

function my_awesome_func(WP_REST_Request $request)


    if (is_user_logged_in() && (int)wp_get_current_user()->ID === 123) 
        //your stuff only for legged in user 123
        return new WP_REST_Response('ok', 200);
    

    return new WP_Error('unauthorized', __('You shall not pass'), [ 'status' => 401 ]); //can also use WP_REST_Response

似乎可能有 proper ways 添加 Woocommerce REST API 端点（找不到有关它的适当文档...）。但我对此进行了测试并且它工作，至少使用 Woocommerce 密钥/秘密身份验证系统，我相信它应用在 /wc/ 端点下。

注意：小心地将路由添加到 wc 端点，因为您可能会覆盖现有的路由端点。例如：添加 /product/mytest 可能与处理 /product/[product_id] 的官方 Woocommerce 路由冲突。

注意 2：我首先使用 custom WordPress REST API route 进行测试，并传递 Woocommerce 密钥/秘密以查看 WordPress 是否可以看到我正确的身份验证和识别。但它不起作用（WP 使用the core API auth system）。所以我转移到了 Woocommerce API 端点。

注意 3：您可以使用带有自定义路由的 Wordpress REST API 和“机器对机器”身份验证插件（如 Oauth、应用程序密码、JWT...如WP REST API authentication documentation page 中所述）来实现相同目的。

【讨论】：

效果很好！你链接到了一个很棒的替代方法。