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 mit zugewiesenem Benutzerkonto unter Menü BENUTZER - API-KEY generiert werden kann. Aufrufe über die Schnittstelle mit diesem Key haben die gleichen Rechte wie der eigentliche 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 ‘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 - Alle Abrufe zu den Statistiken wie batting.json, fielding.json und pitching.json sowie die Abrufe zu den Leaders league_groups/xx/top10/batting/xx.json, league_groups/xx/top10/fielding/xx.json und league_groups/xx/top10/pitching/xx.json oder die eines Boxscores matches/xx/match_boxscore.json

---

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!)

• Allgemeine Daten –> https://bsm.baseball-softball.de/organizations/6.json

• Funktionäre –> https://bsm.baseball-softball.de/organizations/6/organization_functions.json

• Lehrgänge - Liste –> https://bsm.baseball-softball.de/organizations/6/courses.json
• Lehrgang - einzeln –> https://bsm.baseball-softball.de/courses/65.json

• Lehrgang - Teilnehmer –> https://bsm.baseball-softball.de/courses/65/course_participations.json

• Ligen/Gruppen –> https://bsm.baseball-softball.de/organizations/6/league_groups

• Ligen/Gruppen einer Spielklasse –> https://bsm.baseball-softball.de/league_groups/1451.json

• Lizenzen –> https://bsm.baseball-softball.de/organizations/6/licenses.json

• Lizenzen übergreifend (inkl. DBV) –> https://bsm.baseball-softball.de/licenses.json

• Mannschaften - Liste –> https://bsm.baseball-softball.de/organizations/6/teams.json

• Mannschaften einer Spielklasse oder Liga/Gruppe –> https://bsm.baseball-softball.de/leagues/1546/league_entries.json

• Spielfelder - Liste –> https://bsm.baseball-softball.de/fields.json

• Spielklasse - Liste –> https://bsm.baseball-softball.de/organizations/6/leagues.json

• Spielklasse - einzeln –> https://bsm.baseball-softball.de/leagues/1546.json

• Spielpläne –> https://bsm.baseball-softball.de/organizations/6/matches.json

• Spiele einer Liga/Gruppe –> https://bsm.baseball-softball.de/league_groups/1451/matches.json oder https://bsm.baseball-softball.de/league_groups/1blhs/matches.json

• Strafen - Liste –> https://bsm.baseball-softball.de/organizations/6/match_penalties.json

• Strafen einer Liga/Gruppe –> https://bsm.baseball-softball.de/league_groups/1451/match_penalties.json

• Statistiken (Liga)
  • Offensive –> https://bsm.baseball-softball.de/league_groups/5009/statistics/batting.json
  • Defensive –> https://bsm.baseball-softball.de/league_groups/5009/statistics/fielding.json
  • Pitching –> https://bsm.baseball-softball.de/league_groups/5009/statistics/pitching.json
  • Offensive (Top 10) –> https://bsm.baseball-softball.de/league_groups/5009/top10/batting/xx.json
  • Defensive (Top 10) –> https://bsm.baseball-softball.de/league_groups/5009/top10/fielding/xx.json
  • Pitching (Top 10) –> https://bsm.baseball-softball.de/league_groups/5009/top10/pitching/xx.json
    
    
• Statistiken (Mannschaft)
  • Offensive –> https://bsm.baseball-softball.de/league_entries/38432/statistics/batting.json
  • Defensive –> https://bsm.baseball-softball.de/league_entries/38432/fielding.json
  • Pitching –> https://bsm.baseball-softball.de/league_entries/38432/statistics/pitching.json
    
    

• Tabelle einer Liga/Gruppe –> https://bsm.baseball-softball.de/league_groups/1564/table.json oder https://bsm.baseball-softball.de/league_groups/1blhs/table.json

• Verein - Liste –> https://bsm.baseball-softball.de/organizations/6/clubs.json
• Verein - einzeln –> https://bsm.baseball-softball.de/clubs/549.json

---

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

• Allgemeine Daten –> https://bsm.baseball-softball.de/clubs/15.json oder https://bsm.baseball-softball.de/clubs/ros.json

• Funktionäre –> https://bsm.baseball-softball.de/clubs/15/club_functions.json

• Mannschaften –> https://bsm.baseball-softball.de/clubs/15/team_clubs.json

• Spielpläne –> https://bsm.baseball-softball.de/clubs/15/matches.json

• Strafen –> https://bsm.baseball-softball.de/clubs/15/match_penalties.json

• Statistiken
  • Offensive –> https://bsm.baseball-softball.de/clubs/15/statistics/batting.json
  • Defensive –> https://bsm.baseball-softball.de/clubs/15/statistics/fielding.json
  • Pitching –> https://bsm.baseball-softball.de/clubs/15/statistics/pitching.json
    
    

• Lizenzen –> https://bsm.baseball-softball.de/clubs/15/licenses.json

• Spielfelder –> https://bsm.baseball-softball.de/clubs/15/fields.json

---

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!):

• https://bsm.baseball-softball.de/organizations/6/clubs.json?filters[retired]=true –> liefert die ehemaligen Vereine eines Verbandes

• https://bsm.baseball-softball.de/organizations/6/league_groups.json?filters[seasons][]=2015 –> liefert die Ligen/Gruppen aus 2015 eines Verbandes

• https://bsm.baseball-softball.de/matches.json?filters[seasons][]=2016&filters[gamedays][]=any –> liefert alle Spiele aus 2016 eines Verbandes bzw. eines Vereins

• https://bsm.baseball-softball.de/organizations/6/matches.json?sort[league_sort]=asc&sort[time]=asc –> liefert alle Spiele eines Verbandes sortiert nach Liga (Sortierfeld) und Datum

---

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.