API Dokumentation
Die Verleihtool-Schnittstelle ermöglicht den Zugriff auf die Kernelemente des Tools wie: Fahrräder, Zubehör, Preise, Lagerbestände und Reservierungen.
Letzte Aktualisierung: Februar 2024
Einsatz
Die Schnittstelle kann eingesetzt werden um Lücken zu füllen und Funktionen zu erweitern, die weit über die Grundfunktionen hinausgehen.
Beispiele:
- Eigene Interfaces
- Umfassende Statistiken
- Export- und Import-Funktionen
Authentifizierung
Um über die REST-API auf das Verleihtool zugreifen zu können, ist eine Anmeldung erforderlich. Für die Anmeldung ist ein Bearer-Token erforderlich, der nach Kontaktaufnahme mit support@verleihtool.com generiert werden kann.
Fahrräder
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/bikes
Erforderliche Parameter – GET
Einzelne Fahrrad-Daten können über die Fahrrad-ID abgerufen werden:
- https://verleihtool-url/api/bikes/id
Fahrrad hinzufügen – POST
POST-Request mit den erforderlichen Daten an die folgende URL senden:
- https://verleihtool-url/api/bikes
Freie Fahrräder abrufen – GET
Um verfügbare Fahrräder in einem Zeitraum abzurufen, die folgende URL aufrufen:
- https://verleihtool-url/api/bikes/free/start/end
- Beispiel freie Fahrräder morgen:
- https://verleihtool-url/api/bikes/free/2024-12-07/2024-12-07
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| category_id | int (foreign key) | Bike Category |
| price_id | int (foreign key) | Price |
| name | array | |
| size | string | |
| image_id | int (foreign key) | Image |
| attributes | array | |
| sortindex | int | |
| show_frontend | boolean | |
| updated_at | date |
Fahrrad-Kategorien
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/categories
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | array | |
| image_id | int (foreign key) | Image |
| sortindex | int | |
| show_frontend | boolean | |
| updated_at | date |
Zubehör
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/equipments
Erforderliche Parameter – GET
Einzelne Zubehör-Daten können über die Zubehör-ID abgerufen werden:
- https://verleihtool-url/api/equipments/id
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| price_id | int (foreign key) | Price |
| name | array | |
| image_id | int (foreign key) | Image |
| sortindex | int | |
| show_frontend | boolean | |
| updated_at | date |
Reservierungen
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/reservations
Erforderliche Parameter – GET
Reservierungsdetails können über die Reservierung-ID abgerufen werden:
- https://verleihtool-url/api/reservations/id
Reservierung hinzufügen – POST
POST-Request mit den erforderlichen Daten an die folgende URL senden:
- https://verleihtool-url/api/reservations
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| hotel_id | int (foreign key) | Hotel |
| customer | array | |
| number | int | |
| language | string | |
| start_at | date | |
| end_at | date | |
| bikes | array | |
| equipments | array | |
| positions | array | |
| delivery | boolean | |
| price | double | |
| paid | boolean | |
| note | text | |
| reservation_state_id | int (foreign key) | Reservation Status |
| created_at | date | |
| updated_at | date |
Reservierung-Status
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/reservation-states
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | string |
Verleihstationen
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/places
Erforderliche Parameter – GET
Einzelne Verleih-Daten können über die Verleihstation-ID abgerufen werden:
- https://verleihtool-url/api/places/id
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | array | |
| address | array | |
| restdays | string | |
| logo_image_id | int (foreign key) | Image |
| sortindex | int | |
| show_frontend | boolean | |
| updated_at | date |
Preise
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/prices
Erforderliche Parameter – GET
Einzelne Preis-Daten können über die Preis-ID abgerufen werden:
- https://verleihtool-url/api/prices/id
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| type | string | |
| daily_gross | double | |
| scaled_gross | string | |
| onetime_gross | string | |
| halfday_gross | string | |
| is_free | boolean |
Lagerbestand-Fahrräder
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/stock/bikes
Erforderliche Parameter – GET
Details können über die Lagerbestand-ID abgerufen werden:
- https://verleihtool-url/api/stock/bikes/id
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| bike_id | int (foreign key) | Bike |
| place_id | int (foreign key) | Station |
| price_id | int (foreign key) | Price |
| bike_number | string | |
| active | boolean | |
| updated_at | date |
Lagerbestand-Fahrräder
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/stock/equipments
Erforderliche Parameter – GET
Details können über die Lagerbestand-ID abgerufen werden:
- https://verleihtool-url/api/stock/equipments/id
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| equipment_id | int (foreign key) | Equipment |
| place_id | int (foreign key) | Station |
| price_id | int (foreign key) | Price |
| updated_at | date |
Pedale
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/pedals
Pedal hinzufügen – POST
POST-Request mit den erforderlichen Daten an die folgende URL senden:
- https://verleihtool-url/api/pedals
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | array | |
| sortindex | int | |
| show_frontend | boolean | |
| updated_at | date |
Hotels
Um auf diese Ressource zugreifen zu können, einfach die folgende URL aufrufen:
- https://verleihtool-url/api/hotels
Rückgabewerte
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | string | |
| show_frontend | boolean | |
| address | array |