API Reference
APIリファレンス
Blitz Rocket REST API v1の全エンドポイントの完全リファレンス
APIリファレンス
Blitz Rocket REST API v1は、コンテスト、エントリー、ボーナスアクション、購入などを管理するためのエンドポイントを提供します。すべてのエンドポイントは/api/v1で始まります。
エンドポイント概要
| リソース | エンドポイント | メソッド | 認証 |
|---|---|---|---|
| コンテスト | /api/v1/contests | GET | 公開 |
| コンテスト詳細 | /api/v1/contests/:contestId | GET | 公開 |
| エントリー | /api/v1/contests/:contestId/entries | GET, POST | 公開 / 非公開 |
| エントリー詳細 | /api/v1/entries/:entryId | GET, PUT | 公開 / 非公開 |
| 失格 | /api/v1/entries/:entryId/disqualify | POST | 非公開 |
| ポイント | /api/v1/entries/:entryId/points | POST | 非公開 |
| ボーナスアクション | /api/v1/entries/:entryId/bonus-actions | GET | 公開 |
| アクション完了 | /api/v1/entries/:entryId/bonus-actions/:id/complete | POST | 公開 |
| 購入 | /api/v1/contests/:contestId/purchases | POST | 非公開 |
| リーダーボード | /api/v1/contests/:contestId/leaderboard | GET | 公開 |
| 分析 | /api/v1/contests/:contestId/analytics | GET | 公開 |
認証
すべてのエンドポイントは、x-api-keyヘッダーを通じて渡されるAPIキーを必要とします。詳細は認証をご覧ください。
キータイプの権限
- 公開キー — すべての
GETエンドポイントおよびボーナスアクション完了にアクセス可能 - 非公開キー —
POSTおよびPUT操作を含むすべてのエンドポイントにアクセス可能