認証 | Blitz Rocket

認証

すべてのBlitz Rocket API v1エンドポイントはAPIキーによる認証が必要です。APIキーはチーム単位でスコープされ、チーム設定ページから管理できます。

パブリックキーは読み取り専用アクセスを提供し、クライアントサイドのコードで安全に使用できます。アクセス可能なエンドポイントは以下の通りです：

GET /api/v1/contests — コンテスト一覧
GET /api/v1/contests/:contestId — コンテスト詳細取得
GET /api/v1/contests/:contestId/leaderboard — リーダーボード取得
GET /api/v1/contests/:contestId/entries — エントリー一覧
GET /api/v1/contests/:contestId/analytics — アナリティクス取得
GET /api/v1/entries/:entryId — エントリー詳細取得
GET /api/v1/entries/:entryId/bonus-actions — ボーナスアクション取得
POST /api/v1/entries/:entryId/bonus-actions/:bonusActionId/complete — ボーナスアクション完了

プライベートキーはすべてのエンドポイントに対して完全な読み書きアクセスを提供します。これらは秘密にしてサーバーサイドのコードでのみ使用してください。パブリックキーのすべてのエンドポイントに加え、プライベートキーは以下の操作が可能です：

APIキーはリクエストヘッダーの x-api-key に渡してください。クエリパラメータでAPIキーを送信しないでください — ログ、ブラウザ履歴、リファラーヘッダーを通じて漏洩する可能性があります。

bash

curl -X GET https://blitzrocket.com/api/v1/contests \
  -H "x-api-key: vk_live_abc123def456"

APIキーが欠落または無効な場合、401 Unauthorized レスポンスが返されます：

json

{
  "success": false,
  "error": "Missing or invalid API key"
}

パブリックキーでプライベート専用エンドポイントにアクセスした場合、403 Forbidden レスポンスが返されます：

json

{
  "success": false,
  "error": "This endpoint requires a private API key"
}