Documentation de l'API Blitz Rocket

Introduction

L'API Blitz Rocket vous permet de gérer de manière programmatique les concours, les participations, les actions bonus et le suivi des parrainages. Utilisez l'API REST pour intégrer la plateforme de concours Blitz Rocket dans vos applications existantes, automatiser les flux de travail et créer des expériences personnalisées.

URL de base

Toutes les requêtes API doivent être adressées à :

https://blitzrocket.com/api/v1

Ce que vous pouvez faire

• Concours — Lister et récupérer les détails des concours, les analyses et les classements
• Participations — Créer, mettre à jour, disqualifier des participations et gérer les points des participants
• Actions Bonus — Récupérer et compléter les actions bonus pour les participations aux concours
• Achats — Enregistrer et suivre les achats liés aux participations aux concours
• Classement — Récupérer les classements pour n'importe quel concours
• Analyses — Extraire les métriques de performance des concours
• Webhooks — Recevoir des notifications en temps réel pour les inscriptions et les achats
• Suivi des Parrainages — Suivre les visites, inscriptions et achats via les liens de parrainage

Démarrage rapide

1. Obtenez votre clé API — Rendez-vous dans les paramètres de votre équipe sur le tableau de bord Blitz Rocket et créez une clé API
2. Choisissez votre type de clé — Utilisez une clé publique pour un accès en lecture seule ou une clé privée pour un accès complet en lecture/écriture
3. Faites votre première requête — Essayez de lister vos concours :

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

const response = await fetch("https://blitzrocket.com/api/v1/contests", {
  headers: {
    "x-api-key": "your_api_key_here",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://blitzrocket.com/api/v1/contests",
    headers={"x-api-key": "your_api_key_here"}
)
data = response.json()
print(data)

Format de réponse

Toutes les réponses de l'API suivent un format cohérent :

Réponse de succès :

{
  "success": true,
  "data": { ... }
}

Réponse d'erreur :

{
  "success": false,
  "error": "Une description de ce qui a mal tourné"
}

Étapes suivantes

• Authentification — Découvrez les types de clés API et les méthodes d'authentification
• Limites de taux — Comprenez les limites de requêtes
• Référence API — Explorez tous les points de terminaison disponibles