Quagga API概要
Quagga APIでできること
Quagga APIは、イベントの問題・回答・成績を、外部のプログラムからJSON形式で取得するための機能です。 出題画面でしか見られない集計結果やランキングを取り込めるため、独自の順位表示など、参加者への演出に使えます。
取得できる情報は次のとおりです。
直前に集計した問題の集計結果を取得する
直前に集計した問題の概要と回答一覧を取得することができます。
暫定の総合成績を取得する
リクエスト時点での総合成績を取得することができます。
そのほかに取得できる情報
- 問題の一覧と、問題ごとの詳細(回答一覧を含む)
- ピリオドごとのチャンピオン
- ピリオドごとの成績
各APIの詳細はQuagga APIリファレンスを参照してください。
利用できる人
対象イベントの管理者のみが利用できます。
管理者ではないアカウントのアクセストークンを使うと、401 エラーになります。
使い始めるまでの流れ
- プロフィールを開き、「アクセストークン」に記載されている文字列を控えます。
- 取得したいイベントのイベントIDを確認します。回答画面または管理画面のURL(
https://quagga.studio/programs/1/quizの1の部分)がイベントIDです。 - 次のようにリクエストを送ります。
<アクセストークン>は手順1の文字列に置き換えてください。
curl -H "Authorization: Bearer <アクセストークン>" https://quagga.studio/api/v1/programs/1/result/total
このリクエストは、イベントID 1 の暫定総合成績を取得します。
成功すると、順位・獲得ポイント・参加者名などがJSON形式で返ります。
利用するときの注意
- アクセストークンは、イベントの管理者としてデータを取得できる鍵です。他の人に知られないように管理してください。
- 1分間に30リクエストまで受け付けます。超えると
429エラーになります。短い間隔で繰り返し取得するときは、この上限に収まる間隔にしてください。 - 取得だけができます。APIからイベントや問題を変更することはできません。
関連する記事
- Quagga APIリファレンス: 各APIのURL・パラメータ・レスポンスの一覧
- 集計データを活用する: 開催者向けの活用ガイド
- PowerPoint用アドインを使って回答情報を取得する: プログラムを書かずに回答情報を取得する方法