WooCommerce REST API

WooCommerce REST API 是將 WooCommerce 商店連接至外部系統和資源的強大工具。除非你是開發者,否則在大多數情況下,你正在使用的整合只需要你產生 API 金鑰以輸入到他們的系統中,就能連接到外部服務!

本文件涵蓋從商家角度使用 REST API 的基礎知識,並提供開發者文件的連結以了解更進階的主題。

注意:

你可以在 GitHub 上找到 REST API 的技術文件。

需求

WordPress 固定網址必須設定為易於閱讀的格式:設定 > 固定網址。

日期和名稱是很好的預設值,但除了「樸素」以外的任何設定都可以運作

產生 API 金鑰

WooCommerce REST API 使用金鑰系統來控制存取。這些金鑰連結到網站上的使用者。

為特定 WordPress 使用者建立或管理金鑰:

1. 前往 WooCommerce > 設定 > 進階 > REST API。
2. 選擇「建立 API 金鑰」或「新增金鑰」。你會被帶到「金鑰詳情」畫面。
3. 新增「描述」。
4. 在下拉選單中選擇要為其產生金鑰的「使用者」。
5. 選擇此 API 金鑰的存取層級:
   - 讀取存取權限,
   - 寫入存取權限,或;
   - 讀取/寫入存取權限。
6. 選擇「產生 API 金鑰」,WooCommerce 會為該使用者建立 API 金鑰。
7. 現在金鑰已產生,你應該會看到「消費者金鑰」和「消費者密鑰」、「QR 碼」,以及紅色文字的「撤銷金鑰」連結。
8. 「消費者金鑰」和「消費者密鑰」可輸入到使用 WooCommerce REST API 連接的應用程式中。應用程式也可能要求你提供網站的 URL。

啟用舊版 REST API

舊版 REST API 已被棄用並從 WooCommerce 中移除。我們現在已將 WooCommerce 直接整合至 WordPress REST API。若你的網站需要的整合仍需使用舊版 REST API,需要安裝 WooCommerce Legacy REST API 外掛。

這也表示設定為使用舊版 REST API 的 Webhook 也會停止運作,除非安裝專用外掛。

安裝並啟用 Legacy REST API 外掛後,可以在 WooCommerce > 設定 > 進階 > Legacy API 下啟用舊版 REST API,並勾選「啟用舊版 REST API」。

開發者文件

從這裡開始,使用我們的開發者文件說明如何在網站上測試 REST API 以確認其運作。發出基本請求區段概述了如何從網站請求訂單。

你也可以在以下位置找到完整的 REST API 文件:WooCommerce REST API 文件。