Übersicht

Erste Schritte

Die Blitz Rocket API ist eine RESTful API, die Standard-HTTP-Methoden verwendet und JSON-Antworten zurückgibt. Alle Endpunkte sind über https://blitzrocket.com/api/v1 zugänglich.

Voraussetzungen

Bevor Sie API-Aufrufe tätigen, benötigen Sie:

1. Ein Blitz Rocket Konto — Registrieren Sie sich unter blitzrocket.com, falls Sie noch keines haben
2. Ein Team — Erstellen oder treten Sie einem Team in Ihrem Blitz Rocket Dashboard bei
3. Einen API-Schlüssel — Erstellen Sie einen auf der Einstellungsseite Ihres Teams

API-Schlüsseltypen

Blitz Rocket bietet zwei Arten von API-Schlüsseln an:

Anfragen stellen

Alle Anfragen müssen Ihren API-Schlüssel enthalten. Sie können ihn als Header oder Query-Parameter übergeben:

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

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

CORS-Unterstützung

Alle API v1 Endpunkte unterstützen Cross-Origin Resource Sharing (CORS), sodass Sie Anfragen aus browserbasierten Anwendungen stellen können. Die folgenden Header werden bei allen Antworten gesetzt:

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, x-api-key

Inhaltstyp

Für POST- und PUT-Anfragen senden Sie den Anfragekörper als JSON mit dem Header Content-Type: application/json.

Paginierung

Endpunkte, die Listen zurückgeben, unterstützen Paginierung mit den folgenden Query-Parametern:

Paginierte Antworten enthalten ein pagination-Objekt:

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}