Offene Schnittstelle der E-Bike-Garage

Die E-Bike-Garage stellt ihre Status-Informationen via OpenAPI ™ bereit. Ebenso können über die API Reservierungsvorgänge angestoßen werden.

OAS and OpenAPI Specification and their respective logos, are trademarks of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.

Auf der Seite https://api.e-bike-garage.de/api/v1/ wird die offene Schnittstelle aus technischer Perspektive beschrieben.

Einsatzzwecke

Die Schnittstelle bietet alle Möglichkeiten, um die E-Bike-Garage in dritte Anwendungen zu integrieren. Damit wird die Basis geschaffen, verschiedene Verkehrsangebote zu kombinieren und so echte Multimodalität zu ermöglichen.

Dieser Schritt der offenen Freigabe ist notwendig, wie die aktuelle Situation mehr als deutlich zeigt: eine Vielzahl von Anbietern baut rein interne Systeme auf, auf die eine Drittanwendung nicht zugreifen kann. Im Ergebnis müssen für die Nutzung von Sharing-Systemen und anderer Verkehrsinfrastruktur eine Vielzahl von Apps auf dem eigenen Smartphone installiert sei; diese müssen auch alle einzeln gesichtet werden, um eine Übersicht über gewünschte Angebote zu erhalten.

Selbst Versuche, Verkehrs-Informationen in einer App zu vereinen, führen aktuell dazu, dass Verhandlungen mit jedem einzelnen Partner geführt werden müssen. Dies hat neben einer hohen Rechtsunsicherheit auch ein unvollständiges Angebot zur Folge und verhindert freie Standards. Das ist nicht nutzerfreundlich.

Nachfolgend werden einige Anwendungsfälle vorgestellt, welche mit diesen offenen Mobilitätsdaten realisierbar sind:

Gemeinsame Nahverkehrs-App

Öffentlicher Personen-Nahverkehr und Fahrrad-Mobilität passen optimal zusammen, weil man beide gut kombinieren und so schnell von A nach B kommen kann. Doch häufig stellt sich die Frage, wo man sein wertvolles Rad unterstellen kann, während man mit dem Nahverkehr unterwegs ist.

Die E-Bike-Garage mit ihrer Buchungsfunktion ist hier eine optimale Ergänzung. So kann man sich bereits bei der Wahl der Route in einer Nahverkehrs-App einen Platz in der E-Bike-Garage sichern und so gewährleisten, dass das Fahrrad nicht entwendet oder beschädigt wird, während man den ÖPNV nutzt.

Die offene Schnittstelle der E-Bike-Garage ermöglicht es ÖPNV- und anderen Nahverkehrs-Anbietern, den Live-Status inklusive der Buchungsfunktion in ihre App zu integrieren. So braucht der Kunde nur noch eine App, um den kompletten Weg zu fahren.

Tourismus-Informations-App

Eine Fahrradtour wird um so entspannter, wenn man zwischendurch auch einmal etwas essen und trinken kann. Und nicht selten möchte man am Ziel der Radtour auch etwas besichtigen. Die E-Bike-Garage hilft dabei, dass das Fahrrad auch hier sicher abgestellt und bei Bedarf der E-Bike-Akku auch geladen werden kann.

Kombiniert man nun Daten von Ausflugszielen, von Restaurants und von Verkehrsinfrastruktur in der E-Bike-Garage, so hat ein Kunde alle Informationen in einer Hand. Nicht nur, dass er durch Live-Informationen der Garage besser planen kann, er kann durch die ebenfalls in der App eingerichtete Reservierungsfunktion sicherstellen, dass die Garage bei Ankunft frei ist.

Unternehmensinterne Mobilitätsplattform

Mitarbeiterinnen und Mitarbeiter kommen zunehmend nicht nur mit dem Auto, sondern auch mit dem Fahrrad oder E-Bike zur Arbeitsstelle. Dies hilft dem Unternehmen, da Parkplätze vielfach knapp und teuer sind. Darüberhinaus können durch dieses Mobilitätsangebot Klimaziele des Unternehmens erreicht werden.

Doch um ein Fahrrad zu einem alltagstauglichen Verkehrsmittel zu machen, braucht es die Sicherheit, dass man sein Bike sicher und trocken abstellen kann.

Die E-Bike-Garage ermöglicht es, Informationen und Buchungsfunktion in das unternehmenseigene Blog oder Mobilitätsportal aufzunehmen, so dass es für Mitarbeiterinnen und Mitarbeiter viel leichter wird, die Infrastruktur auch zu nutzen.

Lizenz und Nutzungsbedingungen

Die via API bereitgestellten Daten befinden sich unter dem Dach der Creative Commons BY 4.0. Als Urheber ist die Seite e-bike-garage.de anzugeben.

Wir behalten uns vor, bei missbräuchlicher Nutzung (wie z.B. extrem viele Anfragen in kurzer Zeit) Clients zu sperren. Die Daten sind ohne Gewähr.

Datenmodell und Endpunkte

Die E-Bike-Garagen API bietet verschiedene Endpunkte, welche die drei grundlegenden Objekte Container, Box und ReservationRequest zur Verfügung stellt. Diese werden auf der technischen Übersicht genauer beleuchtet. Insbesondere steht auch ein OpenAPI Schema zur weiteren Nutzung bereit.

Die Endpunkte der E-Bike-Garage API.

Unter dem Endpunkt /containers können Container und ihre Boxen abgerufen werden. Dies hilf insbesondere bei der Darstellung als Liste auf Dritt-Websites oder Apps.

Der Endpunkt /geojson dient zur Darstellung auf Karten und liefert die Garagen als GeoJSON aus. Dieses Format ermöglicht die Integration in Kartendarstellungen auf Websites oder in Apps.

Container

Ein Container stellt eine E-Bike-Garage dar. Diese hat vor allem einen geographischen Ort, aber auch einen Namen und eine Beschreibung der Garage.

Box

Ein Container besteht aus (aktuell immer sechs) Boxen, in denen Räder abgestellt werden können. Das Wichtigste an einer Box ist ihr Status sowie die letzte Status-änderung.

ReservationRequest

Ein ReservationRequest stellt eine Reservierungsanfrage dar. Es sind theoretisch beliebige Zugangs-Token möglich, so dass z.B. Mitarbeiter-RFID-Karten integriert werden könnten. Aktuell kann eine Reservierung nur mit einer Handynummer vorgenommen werden. Sendet man eine Reservierungsanfrage ab, so bekommt der Nutzer bei erfolgreicher Reservierung eine SMS mit einem Zugangscode auf die angegebene Handynummer gesendet.