Getting Started
概要
Blitz Rocket API を始めるために必要なすべて
はじめに
Blitz Rocket API は標準的な HTTP メソッドを使用し、JSON レスポンスを返す RESTful API です。すべてのエンドポイントは https://blitzrocket.com/api/v1 からアクセス可能です。
前提条件
API コールを行う前に、以下が必要です：
- Blitz Rocket アカウント — まだお持ちでなければ blitzrocket.com でサインアップしてください
- チーム — Blitz Rocket ダッシュボードでチームを作成または参加してください
- API キー — チーム設定ページから生成してください
API キーの種類
Blitz Rocket では2種類の API キーを提供しています：
| キーの種類 | アクセスレベル | 利用ケース |
|---|---|---|
| パブリック | 読み取り専用エンドポイント + ボーナスアクション完了 | クライアントサイドのウィジェット、リーダーボード表示 |
| プライベート | すべてのエンドポイントへのフルアクセス | サーバーサイドの統合、自動化 |
リクエストの送信
すべてのリクエストには API キーを含める必要があります。ヘッダーまたはクエリパラメータとして渡せます：
bash
curl -X GET https://blitzrocket.com/api/v1/contests \
-H "x-api-key: your_api_key_here"
CORS サポート
すべての API v1 エンドポイントはクロスオリジンリソースシェアリング（CORS）をサポートしており、ブラウザベースのアプリケーションからリクエストが可能です。すべてのレスポンスに以下のヘッダーが設定されています：
text
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, x-api-key
コンテンツタイプ
POST および PUT リクエストでは、リクエストボディを JSON として Content-Type: application/json ヘッダーを付けて送信してください。
ページネーション
リストを返すエンドポイントは以下のクエリパラメータでページネーションをサポートしています：
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
page | 数値 | 1 | ページ番号（1から開始） |
limit | 数値 | 20 | 1ページあたりのアイテム数（最大100） |
ページネーションされたレスポンスには pagination オブジェクトが含まれます：
json
{
"success": true,
"data": [...],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"totalPages": 8
}
}