Documentation API

Intégrez SquadHub.GG dans vos applications avec notre API REST

Premiers pas

1. Obtenez une clé API

L'accès à l'API nécessite de contacter notre équipe. Créez une clé API dans les paramètres de votre compte.

2. Authentification

Incluez votre clé API dans l'en-tête Authorization de chaque requête :

Authorization: Bearer sk_live_your_api_key_here

3. URL de base

https://squadhub.gg/api/v1

4. Limites de requêtes

100 requêtes par minute par clé API

Points d'accès API

GET

/api/v1/tournaments

Lister tous vos tournois

read:tournaments

Paramètres de requête

page(number)Numéro de page (par défaut : 1)

limit(number)Résultats par page (par défaut : 20, max : 100)

status(string)Filtrer par statut (registration, ongoing, completed)

game_id(string)Filtrer par ID de jeu

Réponse

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "Tournament Name",
      "slug": "tournament-slug",
      "status": "registration",
      "format": "single_elimination",
      "team_size": 5,
      "max_teams": 32,
      ...
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45
  },
  "meta": {
    "timestamp": "2025-12-11T...",
    "api_version": "1.0"
  }
}

POST

/api/v1/tournaments

Créer un nouveau tournoi

write:tournaments

Corps de la requête

{
  "name": "Summer Championship 2025",
  "description": "Annual summer tournament",
  "game_id": "uuid",
  "format": "single_elimination",
  "team_size": 5,
  "max_teams": 32,
  "entry_fee": 0,
  "prize_pool": 1000,
  "starts_at": "2025-07-01T18:00:00Z",
  "registration_closes": "2025-06-25T18:00:00Z",
  "rules": "Standard tournament rules apply"
}

Réponse

{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "Summer Championship 2025",
    "slug": "summer-championship-2025-abc123",
    "status": "registration",
    ...
  },
  "meta": { ... }
}

GET

/api/v1/tournaments/{id}

Obtenir les détails d'un tournoi

read:tournaments

Réponse

{
  "success": true,
  "data": {
    "id": "uuid",
    "name": "Tournament Name",
    ...
  },
  "meta": { ... }
}

PATCH

/api/v1/tournaments/{id}

Mettre à jour un tournoi

write:tournaments

Corps de la requête

{
  "name": "Updated Name",
  "max_teams": 64,
  "status": "ongoing"
}

Réponse

{
  "success": true,
  "data": { ... },
  "meta": { ... }
}

DELETE

/api/v1/tournaments/{id}

Supprimer un tournoi

write:tournaments

Réponse

{
  "success": true,
  "data": {
    "message": "Tournament deleted successfully"
  },
  "meta": { ... }
}

GET

/api/v1/tournaments/{id}/registrations

Lister les inscriptions au tournoi

read:registrations

Paramètres de requête

status(string)Filtrer par statut de paiement

Réponse

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "tournament_id": "uuid",
      "team_id": "uuid",
      "payment_status": "complete",
      "registered_at": "2025-06-20T...",
      "teams": {
        "id": "uuid",
        "name": "Team Name",
        "tag": "TAG",
        "logo_url": "..."
      }
    }
  ],
  "meta": { ... }
}

POST

/api/v1/tournaments/{id}/registrations

Inscrire une équipe au tournoi

write:registrations

Corps de la requête

{
  "team_id": "uuid"
}

Réponse

{
  "success": true,
  "data": {
    "id": "uuid",
    "tournament_id": "uuid",
    "team_id": "uuid",
    ...
  },
  "meta": { ... }
}

GET

/api/v1/tournaments/{id}/results

Obtenir les résultats et classements du tournoi

read:results

Réponse

{
  "success": true,
  "data": {
    "tournament": {
      "id": "uuid",
      "format": "single_elimination",
      "status": "completed"
    },
    "matches": [ ... ],
    "standings": [
      {
        "position": 1,
        "team_id": "uuid",
        "team_name": "Champions",
        "team_tag": "CHM"
      }
    ]
  },
  "meta": { ... }
}

Codes d'erreur

400

Requête invalide

Paramètres ou corps de requête invalides

401

Non autorisé

Clé API manquante ou invalide

403

Interdit

Permission requise manquante

404

Non trouvé

Ressource non trouvée

429

Trop de requêtes

Limite de requêtes dépassée

500

Erreur serveur

Une erreur serveur s'est produite

{ "success": true, "data": [ { "id": "uuid", "name": "Tournament Name", "slug": "tournament-slug", "status": "registration", "format": "single_elimination", "team_size": 5, "max_teams": 32, ... } ], "pagination": { "page": 1, "limit": 20, "total": 45 }, "meta": { "timestamp": "2025-12-11T...", "api_version": "1.0" } }

{ "name": "Summer Championship 2025", "description": "Annual summer tournament", "game_id": "uuid", "format": "single_elimination", "team_size": 5, "max_teams": 32, "entry_fee": 0, "prize_pool": 1000, "starts_at": "2025-07-01T18:00:00Z", "registration_closes": "2025-06-25T18:00:00Z", "rules": "Standard tournament rules apply" }

{ "success": true, "data": { "id": "uuid", "name": "Summer Championship 2025", "slug": "summer-championship-2025-abc123", "status": "registration", ... }, "meta": { ... } }

{ "success": true, "data": [ { "id": "uuid", "tournament_id": "uuid", "team_id": "uuid", "payment_status": "complete", "registered_at": "2025-06-20T...", "teams": { "id": "uuid", "name": "Team Name", "tag": "TAG", "logo_url": "..." } } ], "meta": { ... } }

{ "success": true, "data": { "tournament": { "id": "uuid", "format": "single_elimination", "status": "completed" }, "matches": [ ... ], "standings": [ { "position": 1, "team_id": "uuid", "team_name": "Champions", "team_tag": "CHM" } ] }, "meta": { ... } }