API-Schlüssel

Erstellen Sie API-Schlüssel, um externe Systeme zu integrieren, benutzerdefinierte Dashboards zu erstellen oder Arbeitsabläufe mit Balla Stats-Daten zu automatisieren.

Mittelstufe
12 Minuten

Voraussetzungen

Bevor Sie API-Schlüssel erstellen, benötigen Sie Folgendes:

  • Ein Balla Stats-Konto
  • PRO-Plan oder höher

Plangrenzen: FREE = 0 Schlüssel, PRO = 3 Schlüssel (1.000 Anforderungen/Std.), TEAM = 10 Schlüssel (10.000 Anforderungen/Std.), ENTERPRISE = 50 Schlüssel (100.000 Anforderungen/Std.).

Programmatischer API-Zugriff

Erstellen Sie API-Schlüssel, um externe Systeme zu integrieren, benutzerdefinierte Dashboards zu erstellen oder Arbeitsabläufe mit Balla Stats-Daten zu automatisieren.

Bereichsbezogene Berechtigungen

Granulare Zugriffskontrolle

Ratenbegrenzung

Anforderungslimits pro Schlüssel

Nutzungsverfolgung

Vollständiger Prüfpfad

Was Sie lernen werden
  • Navigieren Sie zu API-Schlüssel
  • Erstellen Sie Ihren ersten Schlüssel
  • Kopieren und sicher speichern
  • Verwenden Sie Ihren API-Schlüssel
  • Nutzung überwachen
  • Schlüssel drehen oder entziehen
1
Navigieren Sie zu API-Schlüssel

Klicken Sie in der Dashboard-Seitenleiste auf API Keys. Auf dieser Seite werden alle Ihre vorhandenen Schlüssel angezeigt und Sie können neue Schlüssel erstellen.

API-Schlüsselverwaltungsseite
2
Erstellen Sie Ihren ersten Schlüssel

Klicken Sie auf "API-Schlüssel erstellen", geben Sie einen beschreibenden Namen ein und wählen Sie die Bereiche aus, die Ihr Schlüssel benötigt. Zu den verfügbaren Bereichen gehören: read, write, matches, players, teams, seasons, and stats.

Dialogfeld „API-Schlüssel erstellen“ mit Bereichsauswahl

Beginnen Sie mit dem read-only-Bereich und fügen Sie Schreibberechtigungen nur bei Bedarf hinzu. Dies folgt dem Prinzip des geringsten Privilegs.

3
Kopieren und speichern Sie Ihren Schlüssel

Ihr Schlüssel wird im Format balla_sk_[64 Hex-Zeichen] angezeigt. Dies ist das einzige Mal, dass Sie den vollständigen Schlüssel sehen. Kopieren Sie es sofort und bewahren Sie es an einem sicheren Ort auf.

API-Schlüsselgeheimnis wird einmal angezeigt – jetzt kopieren

YIhr API-Schlüssel wird nur einmal angezeigt. Kopieren Sie ihn jetzt und bewahren Sie ihn sicher auf. Es kann später nicht mehr wiederhergestellt werden. Wenn Sie ihn verlieren, müssen Sie ihn drehen oder einen neuen Schlüssel erstellen.

4
Verwenden Sie Ihren API-Schlüssel

Fügen Sie Ihren API-Schlüssel in den Authorization-Header Ihrer HTTP-Anfragen ein:

curl -H "Authorization: Bearer balla_sk_..." \
  https://api.ballastats.com/api/matches

Oder in JavaScript:

const response = await fetch(
  'https://api.ballastats.com/api/matches',
  {
    headers: {
      'Authorization': 'Bearer balla_sk_...',
      'Content-Type': 'application/json',
    },
  }
);
const data = await response.json();

Alle Endpunkte sind unter /api-docs dokumentiert. Weitere Informationen finden Sie im API-Dokumentation-Tutorial.

5
Nutzung überwachen

Sehen Sie sich den Zeitstempel der letzten Nutzung Ihres Schlüssels, die Gesamtzahl der Anfragen und den aktuellen Status der Ratenbegrenzung an. Nutzungsstatistiken helfen Ihnen zu verstehen, wie Ihre Integrationen funktionieren und wann Sie Ihren Plan möglicherweise aktualisieren müssen.

Statistiken zur API-Schlüsselnutzung
6
Schlüssel drehen oder widerrufen

Rotate ein Schlüssel zum Erstellen eines neuen Schlüssels unter Beibehaltung seines Namens, seiner Bereiche und Einstellungen. Der alte Schlüssel wird sofort widerrufen. Revoke deaktiviert einen Schlüssel dauerhaft. Entzogene Schlüssel können nicht erneut aktiviert werden.

Durch das Drehen eines Schlüssels wird der alte Schlüssel sofort ungültig. Aktualisieren Sie Ihre Integrationen vor der Rotation mit dem neuen Schlüssel, um Ausfallzeiten zu vermeiden.

Tipps

Verwenden Sie beschreibende Namen

Verwenden Sie aussagekräftige Namen wie „Dashboard Bot“ oder „Stats Exporter“, damit Sie den Zweck jedes Schlüssels leicht erkennen können.

Geringstes Privileg

Befolgen Sie das Prinzip der geringsten Rechte – gewähren Sie nur die Bereiche, die Ihre Integration tatsächlich benötigt.

Regelmäßige Rotation

Aus Sicherheitsgründen wechseln Sie die Schlüssel regelmäßig (alle 90 Tage). Richten Sie eine Erinnerung ein, um wichtige Hygienemaßnahmen im Auge zu behalten.

Legen Sie niemals Schlüssel offen

Übertragen Sie API-Schlüssel niemals in den Quellcode und geben Sie sie niemals im Klartext weiter. Verwenden Sie Umgebungsvariablen oder Secret-Manager.

Häufige Probleme

401 Nicht autorisiert

  • Ihr Schlüssel ist möglicherweise inaktiv, widerrufen oder abgelaufen
  • Überprüfen Sie, ob der Schlüssel im Autorisierungsheader
  • enthalten ist Stellen Sie sicher, dass das Headerformat Bearer balla_sk_...

ist 403 Verboten

  • Ihr Schlüssel verfügt nicht über den erforderlichen Bereich für diesen Endpunkt
  • Bearbeiten Sie den Schlüssel, um den erforderlichen Bereich hinzuzufügen (z. B. write für POST-Anfragen hinzufügen)
  • Überprüfen Sie die API-Dokumente, für welche Bereiche jeder Endpunkt

benötigt 429 Zu viele Anfragen

  • Sie haben Ihr Tariflimit für die aktuelle Stunde
  • überschritten Warten Sie, bis das Ratenlimitfenster zurückgesetzt wird, oder aktualisieren Sie Ihren Plan auf höhere Limits
  • Überprüfen Sie den Retry-After-Header darauf, wann Sie es erneut versuchen können