Overzicht

Aan de slag

De Blitz Rocket API is een RESTful API die standaard HTTP-methoden gebruikt en JSON-responses retourneert. Alle endpoints zijn toegankelijk via https://blitzrocket.com/api/v1.

Vereisten

Voordat je API-aanroepen doet, heb je nodig:

1. Een Blitz Rocket-account — Meld je aan op blitzrocket.com als je dat nog niet hebt gedaan
2. Een team — Maak een team aan of word lid van een team in je Blitz Rocket-dashboard
3. Een API-sleutel — Genereer er een via de instellingenpagina van je team

Soorten API-sleutels

Blitz Rocket biedt twee soorten API-sleutels:

Verzoeken doen

Alle verzoeken moeten je API-sleutel bevatten. Je kunt deze meegeven als header of queryparameter:

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-ondersteuning

Alle API v1 endpoints ondersteunen Cross-Origin Resource Sharing (CORS), waardoor je verzoeken kunt doen vanuit browser-gebaseerde applicaties. De volgende headers worden op alle responses gezet:

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

Content Type

Voor POST en PUT verzoeken, stuur je de request body als JSON met de header Content-Type: application/json.

Paginering

Endpoints die lijsten retourneren ondersteunen paginering met de volgende queryparameters:

Gepagineerde responses bevatten een pagination object:

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