Skip to content

快速開始

Quizzz API 讓你透過 HTTPS 管理帳號裡的內容 — 考卷、學生、作業、成績,以及你的公開個人頁。它是一個 REST API:資源導向的 URL、JSON 格式的請求與回應內容、標準的 HTTP 狀態碼。

不想寫程式,只想用講的?用 Claude 連接器 (MCP) 把帳號連到 Claude,直接開口就好。或 開啟 Quizzz ↗ 手動管理。

Base URL

環境Base URL
正式站https://quizzz.techtranslab.com

以下所有端點都是相對於這個 base,例如 https://quizzz.techtranslab.com/api/v1/profile

取得 API 金鑰

API 存取需要 Pro 方案。到 系統設定API 金鑰 頁面建立一把金鑰,選好要授予的權限範圍,再複製金鑰值 — 建立當下 只會顯示一次,格式是 qz_ 開頭。

沒有 Pro 也沒關係 — 改用 MCP

下面的 REST API 需要 Pro,但 Claude 連接器 (MCP) 不限制方案 — 免費方案也能用,而且不需要 API 金鑰。

把金鑰當成密碼看待:它擁有你授予的權限範圍內的完整存取權。請存在伺服器端,絕對不要嵌進前端程式碼。

驗證

每個請求都把金鑰當成 Bearer token 送出:

bash
curl https://quizzz.techtranslab.com/api/v1/info \
  -H "Authorization: Bearer qz_your_key_here"

缺少或無效的金鑰會回 401;金鑰缺少某端點所需的權限範圍則回 403

權限範圍

預設情況下,一把金鑰對你的帳號有 完整存取權。建立金鑰時,你可以選擇把它限制在一個或多個 權限範圍群組 — 在建立金鑰的對話框展開 權限範圍,只勾這把金鑰需要的群組。每個端點都會宣告它所需的權限範圍;各參考頁的表格都有列出。

權限範圍群組權限涵蓋範圍
infoapi:info:read帳號資訊
profileapi:profile:read, api:profile:write公開頁面
brandingapi:branding:read, api:branding:write網站品牌 & SEO
quizapi:quiz:read, api:quiz:write考卷 & 生成
studentapi:student:read, api:student:write學生名單
assignmentapi:assignment:read, api:assignment:write作業 / 分享連結
resultapi:result:read完成成績

速率限制

API 只在 Pro 方案提供 — 非 Pro 方案的金鑰一律以 401 拒絕。Pro 帳號的限制是每個帳號 每分鐘 30 次請求

超過限制會回 429。重複的驗證失敗會另外被節流。

你的第一個呼叫

抓取帳號資訊,確認金鑰可用:

bash
curl https://quizzz.techtranslab.com/api/v1/info \
  -H "Authorization: Bearer qz_your_key_here"
json
{
  "data": {
    "teacher_id": "…",
    "email": "[email protected]",
    "plan_tier": "pro",
    "locale": "en"
  }
}

接下來,前往 API 參考

TechTrans Lab