Woocommerce MCP Server

🚀 WordPress 和 WooCommerce JSON - RPC 接口文檔

本項目提供了 WordPress 和 WooCommerce 的 JSON - RPC 接口文檔，涵蓋了常見的 API 方法、參數說明、示例用法等內容，可幫助開發者擴展和自定義在線商店，自動化業務流程、集成第三方服務並提升客戶體驗。

🚀 快速開始

WooCommerce REST API 提供了一組豐富的功能，允許開發者與在線商店進行交互。以下是使用 WooCommerce REST API 的分步指南：

1. 註冊和認證

步驟 1：註冊開發者帳戶

• 訪問 WooCommerce 插件頁面 並下載插件。
• 在 WordPress 管理面板中激活 WooCommerce 插件。

步驟 2：獲取 API 訪問密鑰

• 登錄到您的 WordPress 管理面板。
• 轉到 WooCommerce > 設置 > 高級 > REST API。
• 生成新的 API 訪問密鑰對。您將獲得消費者密鑰（Consumer Key）和消費者秘密（Consumer Secret）。

2. 安裝 WooCommerce REST API 插件

步驟 3：安裝插件

• 在 WordPress 管理面板中，轉到 插件 > 添加新插件。
• 搜索“WooCommerce REST API”並點擊“立即安裝”。

步驟 4：激活插件

• 安裝完成後，激活該插件。

3. 配置 WooCommerce 設置

步驟 5：配置 REST API 設置

• 轉到 WooCommerce > 設置 > 高級 > REST API。
• 確保啟用“允許 REST API 訪問”選項。

步驟 6：設置 CORS（跨域資源共享）

• 安裝並激活 CORS 插件 來允許跨域請求，特別是如果您計劃從不同的域名調用 API。
• 配置插件以允許您的應用程序的域。

4. 使用 WooCommerce REST API 進行基本操作

步驟 7：測試連接

• 使用 WooCommerce REST API 測試工具 或 Postman 來驗證 API 是否正常工作。
• 發送一個簡單的請求，如獲取產品列表：

GET /wp-json/wc/v3/products
Authentication: Basic <your_consumer_key_and_secret>

步驟 8：創建新用戶

• 使用 POST 請求創建新的商店用戶：

POST /wp-json/wc/v3/users
Content-Type: application/json
Authorization: Basic <your_consumer_key_and_secret>

{
    "username": "newuser",
    "email": "newuser@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "role": "customer"
}

步驟 9：獲取訂單

• 使用 GET 請求獲取所有訂單：

GET /wp-json/wc/v3/orders
Authorization: Basic <your_consumer_key_and_secret>

步驟 10：創建新訂單

• 發送 POST 請求以創建新訂單：

POST /wp-json/wc/v3/orders
Content-Type: application/json
Authorization: Basic <your_consumer_key_and_secret>

{
    "payment_method": "bacs",
    "payment_method_title": "Direct Bank Transfer",
    "status": "pending",
    "customer_id": 1,
    "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "address_1": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postcode": "10001"
    },
    "line_items": [
        {
            "product_id": 93,
            "quantity": 2
        }
    ]
}

步驟 11：更新產品

• 使用 PUT 請求更新現有產品的數據：

PUT /wp-json/wc/v3/products/93
Content-Type: application/json
Authorization: Basic <your_consumer_key_and_secret>

{
    "name": "New Product Name",
    "price": 29.99,
    "description": "Updated product description."
}

步驟 12：刪除產品

• 使用 DELETE 請求刪除產品：

DELETE /wp-json/wc/v3/products/93
Authorization: Basic <your_consumer_key_and_secret>

5. 高級功能

步驟 13：集成支付網關

• 配置 WooCommerce 支付網關，如 Stripe、PayPal 或其他。
• 使用 API 調用支付網關以處理交易。

步驟 14：自動化庫存管理

• 使用 API 來同步庫存數據與第三方系統。
• 監聽 inventory events 並相應地更新產品數量。

步驟 15：創建自定義字段

• 擴展 WooCommerce 數據模型，添加自定義字段。
• 在 API 請求中包含這些字段以豐富您的數據結構。

6. 安全和維護

步驟 16：實施身份驗證

• 使用 OAuth 或其他安全協議來增強 API 的安全性。
• 避免在 URL 中明文傳輸敏感信息。

步驟 17：監控和日誌記錄

• 設置日誌記錄機制以跟蹤 API 請求和響應。
• 使用工具如 ELK Stack 來分析日誌並識別潛在問題。

步驟 18：定期更新插件和主題

• 確保 WooCommerce 插件、 WordPress 核心 和主題都是最新版本，以防止安全漏洞。

步驟 19：實施錯誤處理

• 在代碼中添加錯誤處理邏輯，以應對 API 響應中的潛在問題。
• 返回用戶友好的錯誤消息，並記錄詳細日誌以便調試。

7. 使用第三方工具

步驟 20：利用 Postman 進行 API 測試

• 創建 Postman 集合來組織和測試您的 API 調用。
• 利用 Postman 的環境變量來管理不同的 API 環境配置。

步驟 21：集成 Swagger UI

• 安裝並配置 Swagger UI 插件，以提供交互式和可視化的方式來測試您的 REST API。
• 自動生成 API 文檔，並允許用戶測試 API 請求。

8. 解決問題

步驟 22：處理常見的 HTTP 錯誤狀態碼

• 理解不同的 HTTP 狀態碼（如 401、403、500）及其含義。
• 根據響應頭中的信息進行調試。

步驟 23：檢查 CORS 配置

• 如果您的 API 請求被拒絕，檢查 CORS 設置以確保允許正確的域和請求方法。
• 使用瀏覽器開發者工具查看控制檯中的錯誤消息。

步驟 24：審查日誌文件

• 查看 WordPress 和 WooCommerce 的日誌文件（通常位於 wp - content/debug.log）以獲取更多信息。
• 配置日誌記錄級別，以便在出現問題時捕獲足夠的信息。

9. 進一步學習和優化

步驟 25：閱讀官方文檔

• 深入研究 WooCommerce REST API 官方文檔 以瞭解所有可用的端點和參數。
• 學習如何使用過濾器、排序和其他高級功能來優化您的請求。

步驟 26：加入社區和支持資源

• 參與 WooCommerce 和 REST API 的相關論壇、 Slack 頻道或 Discord 社區，以獲取幫助和分享經驗。
• 查看 GitHub 上的 WooCommerce 倉庫，參與開源項目的發展。

✨ 主要特性

WordPress API 方法

常見方法

• create_post: 創建新帖子
• get_posts: 獲取帖子列表
• update_post: 更新現有帖子
• delete_post: 刪除帖子
• create_page: 創建新頁面
• get_pages: 獲取頁面列表
• update_page: 更新現有頁面
• delete_page: 刪除頁面

WooCommerce 相關方法

涵蓋產品管理、訂單管理、支付網關、報表分析、用戶管理、設置管理、安全認證、插件擴展、數據庫和性能優化、錯誤處理、性能監控等多個方面的常見方法，如獲取產品、創建訂單、處理付款、獲取銷售報表等。

💻 使用示例

WordPress API 示例

基礎用法

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "create_post",
    "params": {
        "siteUrl": "https://your-wordpress-site.com",
        "username": "your-wordpress-ainer",
        "password": "your-wordpress-password",
        "title": "My New Blog Post",
        "content": "This is the content of my new blog post.",
        "status": "publish"
    }
}

WooCommerce 產品示例

基礎用法

獲取產品示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "get_products",
    "params": {
        "perPage": 20,
        "page": 1,
        "filters": {
            "category": 19,
            "status": "publish"
        }
    }
}

創建產品示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "create_product",
    "params": {
        "productData": {
            "name": "Premium T-Shirt",
            "type": "simple",
            "regular_price": "29.99",
            "description": "Comfortable cotton t-shirt, available in various sizes.",
            "short_description": "Premium quality t-shirt.",
            "categories": [
                {
                    "id": 19
                }
            ],
            "images": [
                {
                    "src": "http://example.com/wp-content/uploads/2023/05/shirt.jpg"
                }
            ]
        }
    }
}

WooCommerce 商品變體示例

基礎用法

獲取商品變體示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "get_product_variations",
    "params": {
        "product_id": 123
    }
}

WooCommerce 訂單示例

基礎用法

創建訂單示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "create_order",
    "params": {
        "billing": {
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "address_1": "123 Main St",
            "city": "New York",
            "state": "NY",
            "postcode": "10001"
        },
        "line_items": [
            {
                "product_id": 123,
                "quantity": 2
            }
        ]
    }
}

WooCommerce 支付網關示例

基礎用法

處理付款示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "process_payment",
    "params": {
        "payment_id": 12345,
        "amount": 100.00
    }
}

WooCommerce 報表和分析示例

基礎用法

獲取銷售報表示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "get_sales_report",
    "params": {
        "date_range": "this_month"
    }
}

WooCommerce 用戶示例

基礎用法

創建用戶示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "create_user",
    "params": {
        "user_login": "johndoe",
        "user_email": "john.doe@example.com",
        "first_name": "John",
        "last_name": "Doe"
    }
}

WooCommerce 設置示例

基礎用法

更新設置示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "update_settings",
    "params": {
        "woocommerce": {
            "currency": "USD",
            "payment_methods": ["credit_card", "paypal"]
        }
    }
}

WooCommerce 安全和身份驗證示例

基礎用法

驗證用戶示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "authenticate",
    "params": {
        "username": "johndoe",
        "password": "securepassword"
    }
}

WooCommerce 插件和擴展示例

基礎用法

激活插件示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "activate_plugin",
    "params": {
        "plugin_path": "woocommerce/advanced-seo.php"
    }
}

WooCommerce 數據庫和性能優化示例

基礎用法

優化數據庫示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "optimize_database",
    "params": {
        "tables": ["wc_orders", "wc_order_items"]
    }
}

WooCommerce API 錯誤處理示例

基礎用法

處理錯誤示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "handle_error",
    "params": {
        "error_code": 500,
        "error_message": "Internal Server Error"
    }
}

WooCommerce API 性能監控示例

基礎用法

監控性能示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "monitor_performance",
    "params": {
        "metrics": ["response_time", "request_volume"]
    }
}

WooCommerce API 安全建議示例

基礎用法

實施速率限制示例

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "set_rate_limit",
    "params": {
        "limit": 100,
        "period": "minute"
    }
}

🔧 技術細節

參數說明

常見參數

• siteUrl: (可選，若已設置在環境中) WordPress 站點 URL

WooCommerce 方法的額外參數

• consumerKey: (可選，若已設置在環境中) WooCommerce 消費者密鑰
• consumerSecret: (可選，若已設置在環境中) WooCommerce 消費者秘密

WordPress 方法的額外參數

• username: (可選，若已設置在環境中) WordPress 用戶名
• password: (可選，若已設置在環境中) WordPress 密碼

📄 許可證

文檔中未提及相關許可證信息。

⚠️ 重要提示 在生產環境中使用之前，請確保所有 API 調用經過適當的測試，並採取適當的安全措施，如使用 HTTPS 和強大的身份驗證機制，以保護敏感數據不受未經授權的訪問。

總結

通過以上步驟，您可以成功地配置和使用 WooCommerce REST API 來增強您的電子商務網站的功能。從基本操作到高級集成，WooCommerce 提供了豐富的功能來滿足各種需求。確保您遵循最佳安全實踐，並定期維護您的設置以保持系統的穩定性和安全性。繼續探索和學習，您將能夠充分發揮 WooCommerce REST API 的潛力，為您的業務帶來更大的成功。