WooCommerce REST API 使用全指南:快速连接外部系统的利器

WooCommerce REST API 是一个强大而灵活的接口系统,适合希望将商店连接到第三方服务的使用者和开发人员。本文将帮助你了解 REST API 的基本用法、密钥生成流程、常见问题排查等内容。

什么是 WooCommerce REST API?

它是 WooCommerce 提供的一种接口,用于与外部系统(如 ERP、APP、小程序、库存系统等)交互商品、订单、客户等数据。大多数情况下,只需要生成 API 密钥,并输入到第三方系统中,即可建立连接。

开始前的准备:固定链接设置

REST API 依赖 WordPress 固定链接结构运行。在开始前,检查网站固定链接格式是否已设置为非“纯文本”。

路径:
WordPress 后台 > 设置 > 固定链接
推荐选择:“日和名”格式,或其他结构化形式

步骤一:生成 WooCommerce API 密钥

WooCommerce 使用密钥机制管理访问权限。每组密钥与一个 WordPress 用户绑定。

操作步骤如下:

登录 WordPress 后台

进入 WooCommerce > 设置 > 高级 > REST API
如果你使用的是 WooCommerce 3.4 之前版本,路径为:设置 > API > Key/Apps

点击“添加密钥(Add Key)”填写以下信息:描述:为密钥命名,便于识别

用户:选择一个 WordPress 用户

权限:Read(只读)

Write(只写)

Read/Write(读写)

点击“生成 API 密钥(Generate API Key)”

系统将提供以下内容:

Consumer Key(消费者密钥)

Consumer Secret(消费者秘钥)

二维码

撤销按钮

将密钥和站点地址输入到外部系统后,连接即可建立。

步骤二:测试 API 是否正常

可在浏览器或使用 Postman 工具测试以下链接:

https://yourdomain.com/wp-json/wc/v3/orders?consumer_key=ck_xxx&consumer_secret=cs_xxx

如出现 401 错误或提示“woocommerce_rest_cannot_view”,请检查以下项目:

密钥是否正确

权限是否设置为“读写”

服务器是否正确传递了身份验证信息

为确认服务器支持 Auth 头部,也可以临时在 .htaccess 中添加以下内容:

SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0
RewriteRule ^wp-json/.* – [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]

Legacy REST API(旧版接口)

WooCommerce 曾使用 Legacy REST API 系统,在 WooCommerce 9.0 后,此功能将迁移到独立插件。

如当前仍有旧系统依赖,可按照以下方法启用:

后台进入:WooCommerce > 设置 > 高级 > Legacy API
勾选“启用 Legacy REST API”

新版 REST API 与 WordPress 原生系统整合,并为默认启用状态,建议迁移使用新版。

常见问题解答

Q:请求时出现 401 错误或“woocommerce_rest_cannot_view”?
请检查以下内容:

API 密钥是否正确

权限是否设置为读写

身份验证信息是否通过正确方式传递,可尝试将密钥附加到 URL 参数中进行测试

总结

WooCommerce REST API 提供了强大的数据交互能力,适用于库存同步、订单推送、APP 对接等多种场景。只需完成密钥生成、权限配置和基础测试,即可顺利开始外部系统的连接过程。

如果你在寻找一种自动化、可扩展的商店数据对接方式,REST API 是 WooCommerce 中不可忽视的重要工具。

Leave a Reply

您的电子邮箱地址不会被公开。 必填项已用 * 标注