API Reference

Référence API

Référence complète pour tous les points de terminaison Blitz Rocket REST API v1

Référence API

L'API REST Blitz Rocket v1 fournit des points de terminaison pour gérer les concours, les participations, les actions bonus, les achats, et plus encore. Tous les points de terminaison sont préfixés par /api/v1.

Vue d'ensemble des points de terminaison

RessourcePoint de terminaisonMéthodesAuth
Concours/api/v1/contestsGETPublic
Détail du concours/api/v1/contests/:contestIdGETPublic
Participations/api/v1/contests/:contestId/entriesGET, POSTPublic / Privé
Détail de la participation/api/v1/entries/:entryIdGET, PUTPublic / Privé
Disqualifier/api/v1/entries/:entryId/disqualifyPOSTPrivé
Points/api/v1/entries/:entryId/pointsPOSTPrivé
Actions bonus/api/v1/entries/:entryId/bonus-actionsGETPublic
Compléter l'action/api/v1/entries/:entryId/bonus-actions/:id/completePOSTPublic
Achats/api/v1/contests/:contestId/purchasesPOSTPrivé
Classement/api/v1/contests/:contestId/leaderboardGETPublic
Analytique/api/v1/contests/:contestId/analyticsGETPublic

Authentification

Tous les points de terminaison requièrent une clé API transmise via l'en-tête x-api-key. Voir Authentification pour plus de détails.

Permissions selon le type de clé

  • Clé publique — Peut accéder à tous les points de terminaison GET et à la complétion des actions bonus
  • Clé privée — Peut accéder à tous les points de terminaison, y compris les opérations POST et PUT