Documentation API
Explorez l'API complete de Balla Stats avec la documentation interactive Swagger. Testez les endpoints, consultez les schemas et authentifiez-vous directement dans le navigateur.
Prerequis
Avant d'explorer la documentation API, vous avez besoin de :
- Un compte Balla Stats
- Comprehension de base des APIs REST
Explorez l'API complete de Balla Stats avec la documentation interactive Swagger. Testez les endpoints, consultez les schemas et authentifiez-vous directement dans le navigateur.
Tester les endpoints
Executez des appels API en direct
Voir les schemas
Types compatibles TypeScript
Authentification
Support JWT et cle API
- Acceder a la documentation API
- S'authentifier dans Swagger
- Explorer les endpoints
- Essayer un appel API
- Comprendre les schemas de reponse
- Modeles courants de l'API
Naviguez vers /api-docs dans votre navigateur, ou cliquez sur API Docs dans la barre laterale. L'interface Swagger charge la reference complete de l'API avec tous les endpoints disponibles.
Cliquez sur le bouton "Authorize" en haut de la page. Entrez votre token Bearer - soit un JWT de connexion ou une cle API. Cela authentifie toutes les requetes suivantes effectuees via Swagger UI.
Les endpoints sont organises par categorie pour faciliter la navigation. Developpez n'importe quelle section pour voir les operations disponibles :
Cliquez sur "Try it out" sur n'importe quel endpoint pour le rendre interactif. Remplissez les parametres requis, puis cliquez sur "Execute". Le corps de la reponse, les en-tetes et le code d'etat sont affiches ci-dessous.
Developpez la section Schema sous n'importe quel endpoint pour voir la structure complete de la reponse. Ces types sont compatibles avec les definitions TypeScript dans le paquet @balla-stats/types, facilitant la construction d'integrations typees.
Caracteristiques du schema
- Types de champs : String, number, boolean, array, object avec des definitions de type exactes
- Champs requis : Clairement marques pour distinguer les proprietes optionnelles des requises
- Enums : Valeurs autorisees exactes pour les champs d'etat, roles et types
- Objets imbriques : Extensibles pour montrer la structure complete des relations
L'API de Balla Stats suit des modeles coherents sur tous les endpoints :
Pagination
Utilisez les parametres de requete page et limit. Les reponses incluent le nombre total et les metadonnees de la page actuelle.
Filtrage
Filtrez les resultats avec des parametres de requete comme status, teamId, seasonId et des plages de dates.
Reponses d'erreur
Format coherent avec les champs message et statusCode. Les erreurs de validation incluent des details au niveau des champs.
Formats de date
Toutes les dates utilisent le format ISO 8601 (par exemple, 2026-02-16T10:30:00.000Z). Les horodatages sont toujours en UTC.
Testez avant de coder
Utilisez Swagger pour tester avant d'ecrire le code d'integration. Verifiez que les endpoints retournent les donnees attendues.
Verifiez tous les champs
Verifiez les schemas de reponse pour tous les champs disponibles. Les reponses incluent souvent plus de donnees que prevu.
Les limites de debit s'appliquent
Les limites de debit s'appliquent egalement aux requetes Swagger. Utilisez des cles API pour des limites plus elevees lors de tests intensifs.
Erreur 401 dans Swagger
- Cliquez sur le bouton Authorize et entrez votre token d'abord
- Assurez-vous d'inclure le token complet sans espaces supplementaires
- Les tokens JWT expirent - reconnectez-vous si votre session a expire
Reponses vides
- Verifiez que les parametres de requete sont corrects (par exemple, un ID de groupe valide)
- Verifiez que vous avez acces a la ressource demandee
- Assurez-vous que la ressource existe - essayez de lister tous les elements d'abord