APIと開発者アクセスを設定する

QuestionPunkのREST APIを使って、アンケートと回答をプログラムから扱います。

QuestionPunkは、アンケートと回答のワークフロー向けに公開REST APIを提供しています。APIキーまたはOAuthアクセストークンで認証します。ドキュメントに記載された操作と必要なスコープを使ってください。AIアシスタントは、別のリサーチャー向けMCP接続をOAuthで利用します。

最終確認日
開発者向けAPI連携機能10〜20分中級開発者プロダクトチームリサーチャー

始める前に

公開REST APIを使うのか、別のリサーチャー向けMCP接続を使うのかを先に決めてください。APIキーを作成する前に、Developer設定へアクセスできることを確認してください。

手順

  1. APIキーを作成する

    設定 > Developer > API Keysに移動し、+ Create API Keyをクリックします。名前を入力してキーをコピーします。キーは一度しか表示されないため、安全に保管してください。
  2. リクエストを認証する

    RESTのベースURLはhttps://app.questionpunk.com/api/public/v1です。認証が必要な操作では、Authorization: Bearer <token>ヘッダーにAPIキーまたはOAuthアクセストークンを送信してください。

    英語 UI のデモ画面です。この手順で説明した操作を確認できます。

  3. API仕様を確認する

    対応するメソッド、パス、リクエスト本文、レスポンス形式、必要なスコープを確認するには、公開REST APIのOpenAPI仕様を開きます。MCPツールの引数とRESTのリクエスト本文は別の仕様です。
  4. レート制限に従う

    公開REST APIの制限は、クライアントIPごとに固定60秒の期間内で100リクエストです。返されたレート制限ヘッダーを確認します。リクエストが429を返した場合は、Retry-Afterの指示に従って待ってください。

詳細と制限事項

AIアシスタントを接続する場合は、リサーチャー向けMCP設定ガイドを使ってください。正式な接続先はhttps://app.questionpunk.com/api/v1です。対応クライアントがOAuth情報を見つけ、サインインとアクセス許可の同意を求めます。これは公開RESTのベースURLとは別です。

APIキーは、開発者設定ページで作成、ローテーション、失効ができます。REST連携に必要なスコープを選択してください。認証情報をURLやチャットメッセージに含めないでください。

公開されているOpenAPI仕様は、RESTクライアントライブラリの生成に使えます。アカウントの権限と操作ごとの制限は引き続き適用されます。

RESTのレスポンスにはRateLimit-Policy、RateLimit(IETFドラフト形式)、X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Resetが含まれます。同じクライアントIPから使うキーは同じ制限期間を共有します。新しいキーを作成しても、IPごとの上限は増えません。

結果を確認

APIキーを安全に保管できているか、OAuthを使う想定が決まっており、使うリクエストに対して正しいベースURLとOpenAPI仕様を確認できている状態になります。

うまくいかない場合

リクエストがうまく動かない場合は、RESTでhttps://app.questionpunk.com/api/public/v1を使っているか確認してください。https://app.questionpunk.com/api/v1はMCP用です。