API-Dokumentation
Entdecken Sie die vollständige Balla Stats-API mit interaktiver Swagger-Dokumentation. Testen Sie Endpunkte, zeigen Sie Schemata an und authentifizieren Sie sich direkt im Browser.
Voraussetzungen
Bevor Sie die API-Dokumentation erkunden, benötigen Sie Folgendes:
- Ein Balla Stats-Konto
- Grundlegendes Verständnis von REST-APIs
Entdecken Sie die vollständige Balla Stats-API mit interaktiver Swagger-Dokumentation. Testen Sie Endpunkte, zeigen Sie Schemata an und authentifizieren Sie sich direkt im Browser.
Probieren Sie Endpoints
aus API-Aufrufe live ausführen
Schemata anzeigen
TypeScript-kompatible Typen
Authentifizierung
JWT- und API-Schlüsselunterstützung
- Auf API-Dokumente zugreifen
- Authentifizieren Sie sich in Swagger
- Endpunkte erkunden
- Versuchen Sie es mit einem API-Aufruf
- Antwortschemata verstehen
- Gängige API-Muster
Navigieren Sie in Ihrem Browser zu /api-docs oder klicken Sie in der Seitenleiste auf API Docs. Die Swagger-Benutzeroberfläche lädt die vollständige API-Referenz mit allen verfügbaren Endpunkten.
Klicken Sie oben auf der Seite auf die Schaltfläche „Autorisieren“ . Geben Sie Ihr Bearer-Token ein – entweder ein JWT von der Anmeldung oder einen API-Schlüssel. Dadurch werden alle nachfolgenden Anfragen über die Swagger-Benutzeroberfläche authentifiziert.
Zur einfachen Navigation sind die Endpunkte nach Kategorien geordnet. Erweitern Sie einen beliebigen Abschnitt, um die verfügbaren Operationen anzuzeigen:
Klicken Sie auf "Probieren Sie es aus" an einem beliebigen Endpunkt, um es interaktiv zu machen. Geben Sie die erforderlichen Parameter ein und klicken Sie dann auf "Ausführen". Der Antworttext, die Header und der Statuscode werden unten angezeigt.
Erweitern Sie den Abschnitt Schema unter einem beliebigen Endpunkt, um die vollständige Antwortstruktur anzuzeigen. Diese Typen sind mit den TypeScript-Definitionen im Paket @balla-stats/types kompatibel, sodass sich problemlos typsichere Integrationen erstellen lassen.
Schemafunktionen
- Feldtypen: Zeichenfolge, Zahl, boolescher Wert, Array, Objekt mit genauen Typdefinitionen
- Erforderliche Felder: Deutlich gekennzeichnet, um optionale von erforderlichen Eigenschaften zu unterscheiden
- Enums: Genaue zulässige Werte für Statusfelder, Rollen und Typen
- Verschachtelte Objekte: Erweiterbar, um die vollständige Beziehungsstruktur anzuzeigen
Die Balla Stats API folgt konsistenten Mustern über alle Endpunkte hinweg:
Paginierung
Verwenden Sie die Abfrageparameter page und limit. Zu den Antworten gehören die Gesamtzahl und die Metadaten der aktuellen Seite.
Filtern
Filtern Sie Ergebnisse mit Abfrageparametern wie status, teamId, seasonId und Datumsbereichen.
Fehlermeldungen
Konsistentes Format mit den Feldern message und statusCode. Validierungsfehler umfassen Details auf Feldebene.
Datumsformate
Alle Daten verwenden das ISO 8601-Format (z. B. 2026-02-16T10:30:00.000Z). Zeitstempel sind immer in UTC.
Testen Sie vor dem Codieren
Verwenden Sie Swagger zum Testen, bevor Sie Integrationscode schreiben. Überprüfen Sie, ob Endpunkte die erwarteten Daten zurückgeben.
Alle Felder prüfen
Überprüfen Sie die Antwortschemata für alle verfügbaren Felder. Antworten enthalten oft mehr Daten, als Sie vielleicht erwarten.
Es gelten Tarifbegrenzungen
Auch für Swagger-Anfragen gelten Ratenbeschränkungen. Verwenden Sie API-Schlüssel für höhere Grenzwerte, wenn Sie umfangreiche Tests durchführen.
401 Fehler in Swagger
- Klicken Sie auf die Schaltfläche „Autorisieren“ und geben Sie zuerst Ihr Token ein
- Stellen Sie sicher, dass Sie das vollständige Token ohne zusätzliche Leerzeichen
- angeben JWT-Tokens laufen ab – melden Sie sich erneut an, wenn Ihre Sitzung abgelaufen ist
Leere Antworten
- Überprüfen Sie, ob die Abfrageparameter korrekt sind (z. B. gültige Gruppen-ID)
- Stellen Sie sicher, dass Sie Zugriff auf die angeforderte Ressource
- haben Stellen Sie sicher, dass die Ressource vorhanden ist. Versuchen Sie zunächst, alle Elemente aufzulisten