API-Schnittstelle

Um Daten aus dem Baseball-Softball-Manager (BSM) auf Webseiten (z.B. Homepages von Vereinen oder Verbänden) einbinden zu können, wird eine sogenannte API-Schnittstelle zur Verfügung gestellt. Für den Zugriff über diese Schnittstelle werden i.d.R. entsprechende Rechte für BSM benötigt.

Der Abruf erfolgt über einen API-Key, der unter jeder Person (entsprechende PERSON aufrufen) mit zugewiesenem Benutzerkonto unter Menü BENUTZER - API-KEY generiert werden kann. Aufrufe über die Schnittstelle mit diesem Key haben die gleichen Rechte wie der zugehörige Benutzer. (Hinweis: Ein API-Key kann nur von einem Benutzer generiert werden, der auch Rechte in der Benutzverwaltung besitzt!)

Um einzelne Inhalte auf- bzw. abrufen zu können, muss man den Pfad einer Übersichtsseite (Tabelle) nehmen und mit der Endung .json versehen. Im Anschluss daran folgt der API-Key mit der Syntax: ?api_key=2wSX7mOKyPknSn1M74KuW1, so dass eine komplette Anfrage am Ende in etwa so aussieht: https://bsm.baseball-softball.de/organizations/6.json?api_key=2wSX7mOKyPknSn1M74KuW1

Es gibt zudem 2 ‘freie’ API-Aufrufe, die den Datenabruf ohne API-Key ermöglichen - ‘matches.json’ und ‘table.json’ in Verbindung mit dem Parameter ‘compact=true’: https://bsm.baseball-softball.de/matches.json?compact=true


Mögliche API-Aufrufe sind z.B. (bitte beachten, dass die Daten i.d.R. unstrukturiert sind und für eine Anzeige auf einer Homepage optimiert werden müssen!):

FÜR EINEN VERBAND: (Hinweis: Die Zahl 6 in den Links entspricht der ID des Landesverbands (hier BBSV) im BSM und muss dementsprechend angepasst werden!)


FÜR EINEN VEREIN (Hinweis: Die Zahl 15 in den Links entspricht der ID des Vereins im BSM und muss dementsprechend angepasst werden!)


Ergänzend zu den normalen Aufrufen können zusätzlich auch die Filter aus den Tabellen genutzt werden (sind i.d.R. über Adresszeile des Browsers einsehbar!):


Für die Allgemeinheit steht zur freien Verfügung ein vorgefertigter php-Code oder/und ein Plugin für Wordpress zum Download bereit. Der reine php-Code befindet sich ebenfalls in der zip-Datei, im Unterordner ‘bsm’. Die Dokumentation dazu findet ihr hier.

Anfragen hierzu sind ebenfalls über den BSM-Support per Mail an bsm@baseball-softball.de zu stellen.