動態 QR Code API 文件

    使用 QR Cake API 建立、更新並管理動態 QR Code。產生 API 金鑰、測試請求,把 QR Code 工作流程接到你自己的工具裡。

    JSON REST API建立動態 QR CodeAPI 金鑰驗證MCP 伺服器

    快速上手

    QR Cake API 讓 QR Cake 使用者可以管理自己帳戶底下的 QR Code。

    基礎 URL
    https://api.qrcake.com/v1/product/api

    身分驗證

    在後台建立一組 API 金鑰,並放在 x-api-key 請求標頭中送出。

    每組金鑰都帶有建立時選定的權限(讀取 QR Code、建立和更新 QR Code、讀取掃描分析),完整金鑰只會顯示一次。

    x-api-key: <API Key>
    Content-Type: application/json

    在這裡管理 API 金鑰: 後台 API 金鑰.

    QR Code API 指南:用程式產生與管理 QR Code(2026 年)

    給 AI 助理用的 MCP 伺服器

    QR Cake 也提供遠端 MCP(Model Context Protocol)伺服器,讓 Claude、Claude Code、Cursor 和 VS Code 能在對話中列出、建立、更新和刪除你的 QR Code。登入你的 QR Cake 帳戶即可連接。

    伺服器 URL
    https://api.qrcake.com/mcp
    資源中繼資料(RFC 9728)
    https://api.qrcake.com/.well-known/oauth-protected-resource/mcp

    身分驗證

    用戶端第一次連接時會開啟 QR Cake 登入頁面。請登入,然後核准用戶端可以執行的操作。用戶端不需要輸入 API 金鑰或密碼;API 金鑰只適用於 REST API。

    用戶端可以呼叫哪些工具,取決於你核准的權限。三個不需要權限的工具隨時可用。

    codes.read

    讀取 QR Code 和方案額度

    codes.write

    建立、更新和刪除 QR Code

    analytics.read

    讀取掃描分析(Pro 和 Business 方案)

    工具

    工具權限功能
    list_qr_codes
    codes.read
    列出你擁有的所有 QR Code,包含短網址、目標網址和狀態。
    get_qr_code
    codes.read
    依 ID 取得你的某個 QR Code。
    get_plan_limits
    codes.read
    你的方案等級、QR Code 數量和啟用中 QR Code 數量的用量與上限、是否包含掃描分析,以及自訂網域上限。
    create_qr_code
    codes.write
    建立一個動態 QR Code,其短網址會轉址到指定網址;須遵守方案額度。
    update_qr_code
    codes.write
    不必重新印刷就能變更 QR Code 的目標網址、狀態、中繼資料或選項;未提供的欄位維持原值。
    create_file_upload
    codes.write
    準備上傳要附加到 QR Code 的檔案(圖片、PDF、音訊或影片)。檔案由用戶端自行上傳。
    delete_qr_code
    codes.write
    永久刪除 QR Code;已印刷的 QR Code 將無法再轉址。
    design_qr_code
    codes.read
    codes.write
    為你的某個 QR Code 開啟互動式設計工具,可變更形狀、顏色、Logo 和外框並儲存結果。
    get_qr_code_analytics
    analytics.read
    取得單一 QR Code 的掃描分析(互動、位置、裝置或地理分布,期間為一週、一個月或一年)。需要包含掃描分析的方案。
    render_qr_code無將任何文字或網址產生為白底黑碼的 QR Code 圖片(PNG)或 SVG 標記。不會儲存任何內容。
    build_qr_content無將 WiFi 憑證、聯絡人名片、電子郵件、簡訊、電話、行事曆活動、位置、加密貨幣付款、WhatsApp、地圖或 FaceTime 連結編碼成 QR Code 應承載的文字。
    analyze_qr_design無估算帶有樣式的設計(顏色、碼點樣式、Logo)占用各糾錯區塊的比例,並給出健康、脆弱、危險或超限的判定。

    連接用戶端

    Claude、Claude Code、Cursor 和 VS Code 可以連接。目前尚不接受其他用戶端。

    Claude

    在 Claude 中把伺服器網址新增為自訂連接器,並在系統要求時登入。

    Claude Code
    claude mcp add --transport http qrcake https://api.qrcake.com/mcp

    接著在 Claude Code 中執行 /mcp 並登入。

    Cursor(mcp.json)
    {
      "mcpServers": {
        "qrcake": {
          "url": "https://api.qrcake.com/mcp"
        }
      }
    }
    VS Code(mcp.json)
    {
      "servers": {
        "qrcake": {
          "type": "http",
          "url": "https://api.qrcake.com/mcp"
        }
      }
    }
    • 掃描分析屬於 Pro 和 Business 方案;在免費方案中,get_qr_code_analytics 會回傳錯誤。
    • 透過 MCP 建立的 QR Code,和在後台建立的一樣會計入你的方案額度。
    • 檔案、PDF、圖片、影片和音訊 QR Code 需要上傳檔案。能發送網路請求的用戶端(例如 Claude Code 或 Cursor)可以用 create_file_upload 上傳檔案;否則請在後台建立這類 QR Code。
    • 在支援 MCP Apps 的用戶端(例如 Claude)中,design_qr_code 會直接在對話裡開啟設計工具;其他用戶端則會收到 JSON 格式的 QR Code 資料。
    • 連線最長可維持 30 天,之後用戶端會要求你重新登入。

    API 請求測試工具

    直接在本頁測試各個端點。輸入你的 API 金鑰、選一個端點,就能看到即時回應。

    互動式 API 測試工具

    直接在瀏覽器中對所選的 QR Cake API 端點發出請求。

    GET
    x-api-key: YOUR_API_KEY
    解析後的 URL
    https://api.qrcake.com/v1/product/api/product
    送出請求之後,可以在這裡看到即時狀態碼和回應內容。

    術語說明

    Products(產品)

    QR Code

    Users(使用者)

    QR Cake 帳戶

    請求主體(POST/PUT)

    POST 和 PUT 請求的主體需要先轉成字串。如果送出的是 JSON,請傳入 JSON 字串(例如 JSON.stringify(payload)).

    const payload = { redirect: "https://example.com", metadata: {} };
    
    await fetch(url, {
      method: "POST",
      body: JSON.stringify(payload),
    });
    GET

    取得 QR Code 清單

    列出目前 API 金鑰可以存取的 QR Code。

    在 GitBook 中開啟
    路徑: /product
    URL: https://api.qrcake.com/v1/product/api/product
    請求詳情
    請求標頭
    • x-api-key: <API Key>
    • Accept: application/json
    回應
    200 OK
    [
      {
        "accountId": "string",
        "productId": "string",
        "userId": "string",
        "redirect": "string",
        "state": "ACTIVE",
        "metadata": {},
        "createdAt": 0,
        "updatedAt": 0
      }
    ]
    401 未授權
    {
      "message": {}
    }

    Products 就是 QR Code。

    GET

    取得單一 QR Code

    取得一個 QR Code 的詳細資料。

    在 GitBook 中開啟
    路徑: /product/{productId}
    URL: https://api.qrcake.com/v1/product/api/product/{productId}
    請求詳情
    路徑參數
    • productId (string)
    請求標頭
    • x-api-key: <API Key>
    • Accept: application/json
    回應
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 未授權
    {
      "message": {}
    }
    POST

    建立 QR Code

    建立一個新的 QR Code 產品。

    在 GitBook 中開啟
    路徑: /product
    URL: https://api.qrcake.com/v1/product/api/product
    請求詳情
    請求標頭
    • x-api-key: <API Key>
    • Content-Type: application/json
    • Accept: application/json
    請求主體範本
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    回應
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "createdAt": 0,
      "updatedAt": 0
    }
    401 未授權
    {
      "message": {}
    }

    POST 的主體必須轉成字串(例如 JSON.stringify(payload))。

    PUT

    更新 QR Code

    更新一個既有的 QR Code(product)。

    在 GitBook 中開啟
    路徑: /product/{productId}
    URL: https://api.qrcake.com/v1/product/api/product/{productId}
    請求詳情
    路徑參數
    • productId (string)
    請求標頭
    • x-api-key: <API Key>
    • Content-Type: application/json
    • Accept: application/json
    請求主體範本
    {
      "redirect": "https://example.com",
      "metadata": {},
      "state": "ACTIVE"
    }
    回應
    200 OK
    {
      "accountId": "string",
      "productId": "string",
      "userId": "string",
      "redirect": "string",
      "state": "ACTIVE",
      "metadata": {},
      "expiresAt": 0,
      "createdAt": 0,
      "updatedAt": 0
    }
    401 未授權
    {
      "message": {}
    }

    PUT 的主體必須轉成字串。

    DELETE

    刪除 QR Code

    刪除一個 QR Code。

    在 GitBook 中開啟
    路徑: /product/{productId}
    URL: https://api.qrcake.com/v1/product/api/product/{productId}
    請求詳情
    路徑參數
    • productId (string)
    請求標頭
    • x-api-key: <API Key>
    • Accept: application/json
    回應
    200 OK
    {
      "productId": "string"
    }
    401 未授權
    {
      "message": {}
    }
    GET

    權限

    回傳這組 API 金鑰擁有的權限。

    在 GitBook 中開啟
    路徑: /permission
    URL: https://api.qrcake.com/v1/product/api/permission
    請求詳情
    請求標頭
    • x-api-key: <API Key>
    • Accept: application/json
    回應
    200 OK
    {
      "success": true,
      "result": {
        "tier": "subscriber",
        "active": true,
        "analytics": true,
        "productLimit": 100,
        "productTotal": 3,
        "productActiveLimit": 100,
        "productActiveTotal": 3
      }
    }
    401 未授權
    {
      "message": {}
    }

    支援的 QR Code 類型

    建立或更新 QR Code 產品時,請使用這些中繼資料類型。

    redirect, link, image, video, file, pdf, audio, app, event, vCard, review, email

    可以先從我們首頁的 動態 QR Code 和 可編輯 QR Code 開始了解。