API-documentatie
Ontdek de volledige Balla Stats API met interactieve Swagger-documentatie. Test eindpunten, bekijk schema's en authenticeer rechtstreeks in de browser.
Vereisten
Voordat u de API-documentatie gaat verkennen, heeft u het volgende nodig:
- Een Balla Stats-account
- Basiskennis van REST API's
Ontdek de volledige Balla Stats API met interactieve Swagger-documentatie. Test eindpunten, bekijk schema's en authenticeer rechtstreeks in de browser.
Probeer Eindpunten
Voer API-aanroepen live uit
Schema's bekijken
TypeScript-compatibele typen
Authenticatie
Ondersteuning voor JWT en API-sleutel
- Toegang tot API-documenten
- Verifiëren in Swagger
- Eindpunten verkennen
- Probeer een API-aanroep
- Antwoordschema's begrijpen
- Algemene API-patronen
Navigeer naar /api-docs in uw browser, of klik op API Docs in de zijbalk. De Swagger-gebruikersinterface laadt de volledige API-referentie met alle beschikbare eindpunten.
Klik op de "Authorize" knop bovenaan de pagina. Voer uw Bearer-token in: een JWT van login of een API-sleutel. Hiermee worden alle daaropvolgende verzoeken geverifieerd die via de Swagger-gebruikersinterface worden gedaan.
Eindpunten zijn geordend op categorie voor eenvoudige navigatie. Vouw een sectie uit om de beschikbare bewerkingen te zien:
Klik op "Probeer het eens" op een willekeurig eindpunt om het interactief te maken. Vul de vereiste parameters in en klik vervolgens op "Uitvoeren" . De antwoordtekst, headers en statuscode worden hieronder weergegeven.
Vouw de sectie Schema onder een eindpunt uit om de volledige responsstructuur te bekijken. Deze typen zijn compatibel met de TypeScript-definities in het @balla-stats/types-pakket, waardoor het eenvoudig wordt om typeveilige integraties te bouwen.
Schemafuncties
- Veldtypen: Tekenreeks, getal, booleaanse waarde, array, object met exacte typedefinities
- Verplichte velden: Duidelijk gemarkeerd om optionele van vereiste eigenschappen te onderscheiden
- Enums: Exacte toegestane waarden voor statusvelden, rollen en typen
- Geneste objecten: Uitbreidbaar om de volledige relatiestructuur weer te geven
De Balla Stats API volgt consistente patronen op alle eindpunten:
Paginering
Gebruik de queryparameters page en limit. De reacties omvatten het totale aantal en de huidige metagegevens van de pagina.
Filteren
Filter resultaten met queryparameters zoals status, teamId, seasonId en datumbereiken.
Foutreacties
Consistent formaat met de velden message en statusCode. Validatiefouten omvatten details op veldniveau.
Datumformaten
Alle datums gebruiken het ISO 8601-formaat (bijvoorbeeld 2026-02-16T10:30:00.000Z). Tijdstempels zijn altijd in UTC.
Test vóór het coderen
Gebruik Swagger om te testen voordat u integratiecode schrijft. Controleer of eindpunten de verwachte gegevens retourneren.
Controleer alle velden
Controleer de antwoordschema's voor alle beschikbare velden. Reacties bevatten vaak meer gegevens dan u zou verwachten.
Tarieflimieten zijn van toepassing
Tarieflimieten zijn ook van toepassing op Swagger-verzoeken. Gebruik API-sleutels voor hogere limieten bij uitgebreid testen.
401-fout in Swagger
- Klik op de knop Autoriseren en voer eerst uw token in
- Zorg ervoor dat u het volledige token opneemt, zonder extra spaties
- JWT-tokens verlopen - log opnieuw in als uw sessie is verlopen
Lege reacties
- Controleer of de queryparameters correct zijn (bijvoorbeeld een geldige groeps-ID)
- Controleer of u toegang heeft tot de aangevraagde bron
- Zorg ervoor dat de bron bestaat. Probeer eerst alle items op te sommen