Dieser Artikel richtet sich an Studio-Owner und -Admins, die andere Tools mit bsport verbinden. Er behandelt das Erstellen, Nachverfolgen und Widerrufen von API-Schlüsseln in den Einstellungen. Für Event-Benachrichtigungen siehe „Deine Webhooks verwalten".
Weitere Informationen zur öffentlichen bsport-API findest du in der entsprechenden Dokumentation
Übersicht
Mit einem API-Schlüssel kann ein Tool deiner Wahl deine Studiodaten über die bsport-API lesen und aktualisieren. Reporting-Tools, individuelle Integrationen und Automatisierungsplattformen nutzen Schlüssel für die Verbindung.
Verwalte Schlüssel unter Einstellungen > Webhooks & APIs, im Tab API. Jeder Schlüssel gehört zu deinem Studio und ist mit einem Tool-Namen verknüpft, sodass du siehst, welches Tool welchen Schlüssel nutzt.
Wer kann es nutzen:
Bedingung | Was du siehst |
Du hast die Rolle Owner oder Admin, und dein bsport-Plan umfasst die Public API (Build, Engage oder Elevate) | Den Tab API mit deinen Schlüsseln und der Schaltfläche API-Schlüssel erstellen. |
Du hast die Rolle Owner oder Admin, und dein bsport-Plan umfasst die Public API nicht | Die Meldung „Upgrade deinen Plan, um die API zu nutzen". Kontaktiere bsport für ein Upgrade. |
Jede andere Rolle | Kein API-Tab. Der Tab Webhooks bleibt verfügbar, wenn deine Rolle die Berechtigung für Webhooks hat. |
Die Public API kann auch außerhalb dieser Pläne zu einem Studio hinzugefügt werden. Kontaktiere bsport für weitere Informationen.
Was du tun kannst
Einen API-Schlüssel für ein Tool erstellen.
Festlegen, wie lange der Schlüssel gültig bleibt: 3 Monate, 6 Monate oder 1 Jahr.
Jeden Schlüssel mit Tool, Ablaufdatum, Erstellungsdatum, Kontakt und Status einsehen.
Einen Schlüssel widerrufen, wenn du ein Tool nicht mehr nutzt oder ein Leck vermutest.
Die API-Dokumentation über den Link oben rechts auf der Seite öffnen.
Häufige Anwendungsfälle
So erstellst du einen API-Schlüssel
Gehe zu Einstellungen > Webhooks & APIs und öffne den Tab API.
Wähle API-Schlüssel erstellen.
Fülle das Formular aus:
Tool-Name (erforderlich): bis zu 24 Zeichen, mit Kleinbuchstaben, Ziffern, Bindestrichen oder Unterstrichen, zum Beispiel
reporting-tool. Ein aktiver Schlüssel darf sich keinen Tool-Namen mit einem anderen aktiven Schlüssel teilen.Läuft ab in: 3 Monate (Standard), 6 Monate oder 1 Jahr. Der Schlüssel funktioniert am Ende dieses Zeitraums nicht mehr.
Kontakt-E-Mail (optional): wen bsport zu diesem Schlüssel kontaktiert. Lass das Feld leer, um die E-Mail-Adresse des Studio-Owners zu verwenden.
Wähle Erstellen.
Lies den Hinweis im Formular. Ein Schlüssel gewährt vollen Admin-Zugriff auf dein Studio, einschließlich Kundendaten und Zahlungen. Teile ihn nur mit Tools und Personen, denen du vertraust.
So speicherst du deinen Schlüssel
Nachdem du Erstellen gewählt hast, zeigt das Fenster API-Schlüssel speichern den Schlüssel an. Das ist das einzige Mal, dass du ihn siehst.
Wähle Schlüssel kopieren und bewahre ihn in einem Passwortmanager auf. Teile ihn nicht per E-Mail oder Chat.
Wähle Header kopieren, um zu kopieren, was dein Tool mit jeder Anfrage senden muss.
Wähle Schließen.
Wenn du das Fenster schließt, bevor du kopiert hast, bittet dich bsport um eine Bestätigung. Schließt du es trotzdem, kannst du den Schlüssel nicht mehr sehen: Erstelle einen neuen Schlüssel und widerrufe den ersten.
So verbindest du dein Tool
Dein Tool sendet bei jeder Anfrage an die bsport-API zwei Header:
Header | Wert |
| Der von dir gewählte Tool-Name. |
| Der von dir kopierte Schlüssel. |
Endpunkte und Beispiele findest du in der API-Dokumentation.
So widerrufst du einen Schlüssel
Finde den Schlüssel im Tab API in der Liste.
Wähle Schlüssel widerrufen.
Bestätige im Fenster API-Schlüssel widerrufen?
Das Tool funktioniert sofort nicht mehr, und das lässt sich nicht rückgängig machen. Der Schlüssel bleibt mit dem Status Widerrufen und dem Widerrufsdatum in der Liste. Sein Tool-Name wird wieder verfügbar.
So ersetzt du einen Schlüssel vor dem Ablauf
Schlüssel können nicht bearbeitet oder verlängert werden. So erneuerst du einen:
Erstelle einen neuen Schlüssel mit einem neuen Tool-Namen, zum Beispiel
reporting-tool-2, oder verwende den Namen erneut, sobald der alte Schlüssel abgelaufen oder widerrufen ist.Aktualisiere dein Tool mit dem neuen Schlüssel.
Widerrufe den alten Schlüssel.
So funktioniert es
Einrichtung. Ein Owner oder Admin erstellt den Schlüssel und kopiert ihn einmalig.
Aktivierung. Der Schlüssel funktioniert, sobald er existiert. Dein Tool sendet die beiden Header mit jeder Anfrage.
Normale Nutzung. Die Liste zeigt den Status jedes Schlüssels.
Nach der Aktion. Widerrufe einen Schlüssel, um ihn sofort zu stoppen, oder lass ihn ablaufen.
Schlüsselstatus
Status | Bedeutung |
Aktiv | Der Schlüssel funktioniert und läuft erst in mehr als 30 Tagen ab. |
Läuft bald ab | Der Schlüssel funktioniert noch und läuft innerhalb von 30 Tagen ab. Plane seinen Ersatz. |
Abgelaufen | Der Schlüssel hat sein Ablaufdatum erreicht und funktioniert nicht mehr. |
Widerrufen | Du hast den Schlüssel widerrufen. Er funktioniert nicht mehr. |
In der Spalte Kontakt kennzeichnet Du die Schlüssel, die deine eigene E-Mail-Adresse aufführen.
Wichtige Hinweise
Einmalige Anzeige. bsport speichert den Schlüssel nicht in lesbarer Form. Niemand kann ihn erneut anzeigen, auch bsport nicht.
Limit von 50 Schlüsseln. Ein Studio kann 50 nicht widerrufene Schlüssel halten. Abgelaufene Schlüssel zählen mit, bis du sie widerrufst. Bei Erreichen des Limits zeigt die Seite einen Hinweis, und das Erstellungsformular kann nicht gesendet werden: Widerrufe einen abgelaufenen Schlüssel, um einen weiteren zu erstellen.
Eindeutige Tool-Namen. Der Name darf nicht mit dem eines aktiven Schlüssels übereinstimmen. Abgelaufene und widerrufene Schlüssel geben ihren Namen wieder frei.
Voller Zugriff. Ein Schlüssel ist nicht auf einen Bereich deines Studios beschränkt. Erstelle einen Schlüssel pro Tool, damit du ein einzelnes Tool widerrufen kannst, ohne die anderen zu beeinträchtigen.
Planänderungen. Wenn dein bsport-Plan die Public API nicht mehr umfasst, zeigt der Tab API die Upgrade-Meldung an, und bsport lehnt neue Schlüssel ab.
Webhooks sind separat. API-Schlüssel erstellen keine Webhooks. Siehe „Deine Webhooks verwalten".
FAQ
Ich habe meinen Schlüssel verloren. Kann ich ihn erneut anzeigen?
Nein. Erstelle einen neuen Schlüssel, aktualisiere dein Tool und widerrufe den verlorenen.
Warum habe ich keinen API-Tab?
Der Tab ist nur für Owner und Admins. Bitte einen von ihnen, den Schlüssel zu erstellen.
Warum sehe ich „Upgrade deinen Plan, um die API zu nutzen"?
Dein bsport-Plan umfasst die Public API nicht. Sie ist in Build, Engage und Elevate enthalten. Kontaktiere bsport, um ein Upgrade durchzuführen oder sie hinzuzufügen.
Für wen ist die Kontakt-E-Mail gedacht?
Das ist die Person, die bsport bezüglich des Schlüssels kontaktiert. Lässt du das Feld leer, verwendet bsport die E-Mail-Adresse des Studio-Owners.
Kann ich ein Ablaufdatum wählen?
Das Formular bietet 3 Monate, 6 Monate oder 1 Jahr an.
Dauert das Widerrufen eines Schlüssels?
Nein. Das Tool wird sofort abgelehnt.