Aperçu

Premiers pas

L'API Blitz Rocket est une API RESTful qui utilise les méthodes HTTP standard et renvoie des réponses JSON. Tous les points de terminaison sont accessibles via https://blitzrocket.com/api/v1.

Prérequis

Avant de faire des appels API, vous aurez besoin de :

1. Un compte Blitz Rocket — Inscrivez-vous sur blitzrocket.com si ce n'est pas déjà fait
2. Une équipe — Créez ou rejoignez une équipe dans votre tableau de bord Blitz Rocket
3. Une clé API — Générez-en une depuis la page des paramètres de votre équipe

Types de clés API

Blitz Rocket propose deux types de clés API :

Effectuer des requêtes

Toutes les requêtes doivent inclure votre clé API. Vous pouvez la passer en tant qu'en-tête ou paramètre de requête :

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"

Support CORS

Tous les points de terminaison de l'API v1 supportent le Cross-Origin Resource Sharing (CORS), vous permettant de faire des requêtes depuis des applications basées sur navigateur. Les en-têtes suivants sont définis sur toutes les réponses :

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

Type de contenu

Pour les requêtes POST et PUT, envoyez votre corps de requête en JSON avec l'en-tête Content-Type: application/json.

Pagination

Les points de terminaison qui renvoient des listes supportent la pagination avec les paramètres de requête suivants :

Les réponses paginées incluent un objet pagination :

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