API Reference
API Referenz
Vollständige Referenz für alle Blitz Rocket REST API v1 Endpunkte
API Referenz
Die Blitz Rocket REST API v1 bietet Endpunkte zur Verwaltung von Wettbewerben, Einträgen, Bonusaktionen, Käufen und mehr. Alle Endpunkte sind mit /api/v1 vorangestellt.
Endpunktübersicht
| Ressource | Endpunkt | Methoden | Auth |
|---|---|---|---|
| Wettbewerbe | /api/v1/contests | GET | Öffentlich |
| Wettbewerbsdetails | /api/v1/contests/:contestId | GET | Öffentlich |
| Einträge | /api/v1/contests/:contestId/entries | GET, POST | Öffentlich / Privat |
| Eintragsdetails | /api/v1/entries/:entryId | GET, PUT | Öffentlich / Privat |
| Disqualifizieren | /api/v1/entries/:entryId/disqualify | POST | Privat |
| Punkte | /api/v1/entries/:entryId/points | POST | Privat |
| Bonusaktionen | /api/v1/entries/:entryId/bonus-actions | GET | Öffentlich |
| Aktion abschließen | /api/v1/entries/:entryId/bonus-actions/:id/complete | POST | Öffentlich |
| Käufe | /api/v1/contests/:contestId/purchases | POST | Privat |
| Bestenliste | /api/v1/contests/:contestId/leaderboard | GET | Öffentlich |
| Analysen | /api/v1/contests/:contestId/analytics | GET | Öffentlich |
Authentifizierung
Alle Endpunkte erfordern einen API-Schlüssel, der über den Header x-api-key übergeben wird. Details siehe Authentifizierung.
Berechtigungen der Schlüsseltypen
- Öffentlicher Schlüssel — Kann alle
GETEndpunkte und das Abschließen von Bonusaktionen aufrufen - Privater Schlüssel — Kann alle Endpunkte einschließlich
POSTundPUTOperationen aufrufen