Skip to content

はじめに

Quizzz API は、クイズ・生徒・課題・結果・公開プロフィールページなど、アカウントのコンテンツを HTTPS 経由で管理できる REST API です。リソース指向の URL、JSON 形式のリクエスト/レスポンス、標準的な HTTP ステータスコードを採用しています。

コードより自然な言葉が好みですか? Claude コネクター (MCP) でアカウントを Claude に接続して、話しかけるだけ。または Quizzz を開く ↗ で手動で管理できます。

ベース URL

環境ベース URL
本番https://quizzz.techtranslab.com

以下のエンドポイントはすべてこのベースからの相対パスです。例:https://quizzz.techtranslab.com/api/v1/profile

API キーの取得

API アクセスは Pro プランで利用できます。アカウント設定の API Keys からキーを作成し、付与するスコープを選んでキーの値をコピーしてください。値は作成時に 一度だけ 表示され、qz_ で始まります。

Pro プランがなくても大丈夫 — MCP を使う

以下の REST API は Pro が必要ですが、Claude コネクター (MCP) はプランの制限がなく、無料プランでも利用でき、API キーも不要です。

キーはパスワードと同じように扱ってください。付与したスコープのフルアクセス権を持ちます。サーバー側に保管し、クライアント側のコードには絶対に埋め込まないでください。

認証

すべてのリクエストで、キーを Bearer トークンとして送ります:

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

キーが無い、または無効な場合は 401 を返します。エンドポイントが要求するスコープをキーが持たない場合は 403 を返します。

スコープ

デフォルトでは、キーはアカウントへの フルアクセス を持ちます。キーを作成するときに、1つ以上の スコープグループ に制限することもできます。キーのダイアログで Scopes を展開し、必要なグループだけにチェックを入れてください。各エンドポイントが必要とするスコープは、各リファレンスページの表に記載されています。

スコープグループ権限対象
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 プランでのみ利用できます — 他のプランのキーは 401 で拒否されます。Pro アカウントはアカウントごとに 1分あたり 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