Blitz Rocket APIドキュメント
Blitz Rocket APIで強力なコンテストおよびギブアウェイ統合を構築する
はじめに
Blitz Rocket APIを使うと、コンテスト、エントリー、ボーナスアクション、リファラルトラッキングをプログラムで管理できます。REST APIを利用してBlitz Rocketのコンテストプラットフォームを既存のアプリケーションに統合し、ワークフローを自動化し、カスタム体験を構築しましょう。
ベースURL
すべてのAPIリクエストは以下に送信してください：
text
https://blitzrocket.com/api/v1
できること
- コンテスト — コンテストの一覧取得、詳細、分析、リーダーボードの取得
- エントリー — エントリーの作成、更新、失格処理、参加者ポイントの管理
- ボーナスアクション — コンテストエントリーのボーナスアクションの取得と完了
- 購入 — コンテストエントリーに紐づく購入の記録と追跡
- リーダーボード — 任意のコンテストのランキングリーダーボードの取得
- 分析 — コンテストのパフォーマンス指標の取得
- Webhook — サインアップや購入のリアルタイム通知の受信
- リファラルトラッキング — リファラルリンク経由の訪問、サインアップ、購入の追跡
クイックスタート
- APIキーを取得する — Blitz Rocketダッシュボードのチーム設定に移動し、APIキーを作成します
- キータイプを選択する — 読み取り専用アクセスにはパブリックキー、完全な読み書きアクセスにはプライベートキーを使用します
- 最初のリクエストを送る — コンテストの一覧を取得してみましょう：
bash
curl -X GET https://blitzrocket.com/api/v1/contests \
-H "x-api-key: your_api_key_here"
レスポンス形式
すべてのAPIレスポンスは一貫した形式に従います：
成功レスポンス：
json
{
"success": true,
"data": { ... }
}
エラーレスポンス：
json
{
"success": false,
"error": "何が問題だったかの説明"
}