Documentazione API
L'API consente l'accesso agli elementi chiave dello strumento come: biciclette, accessori, prezzi, inventario, prenotazioni e altro.
Ultimo aggiornamento: Febbraio 2024
Utilizzo
L'interfaccia può essere utilizzata per colmare le lacune e ampliare le funzionalità ben oltre ciò che Verleihtool può fare da solo.
Esempi:
- Interfacce personalizzate
- Statistiche complete
- Funzioni di esportazione e importazione
Autenticazione
Per accedere a Verleihtool tramite REST-API, è necessaria l'autenticazione. Per l'autenticazione è richiesto un Bearer Token, che può essere generato contattando support@verleihtool.com.
Biciclette
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/bikes
Parametri richiesti – GET
I dati di una singola bicicletta possono essere recuperati tramite l'ID della bicicletta:
- https://verleihtool-url/api/bikes/id
Aggiungere una bicicletta – POST
Inviare una POST-Request con i dati richiesti al seguente URL:
- https://verleihtool-url/api/bikes
Ottenere biciclette disponibili – GET
Per recuperare le biciclette disponibili in un determinato periodo, richiamare il seguente URL:
- https://verleihtool-url/api/bikes/free/start/end
- Esempio di biciclette libere domani:
- https://verleihtool-url/api/bikes/free/2024-11-22/2024-11-22
Valori di ritorno
| 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 |
Categorie di biciclette
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/categories
Valori di ritorno
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | array | |
| image_id | int (foreign key) | Image |
| sortindex | int | |
| show_frontend | boolean | |
| updated_at | date |
Accessori
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/equipments
Parametri richiesti – GET
I dati di un singolo accessorio possono essere recuperati tramite l'ID dell'accessorio:
- https://verleihtool-url/api/equipments/id
Valori di ritorno
| 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 |
Prenotazioni
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/reservations
Parametri richiesti – GET
I dettagli della prenotazione possono essere recuperati tramite l'ID della prenotazione:
- https://verleihtool-url/api/reservations/id
Aggiungere una prenotazione – POST
Inviare una POST-Request con i dati richiesti al seguente URL:
- https://verleihtool-url/api/reservations
Valori di ritorno
| 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 |
Stato delle prenotazioni
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/reservation-states
Valori di ritorno
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | string |
Stazioni di noleggio
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/places
Parametri richiesti – GET
I dati di una singola stazione di noleggio possono essere recuperati tramite l'ID della stazione:
- https://verleihtool-url/api/places/id
Valori di ritorno
| 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 |
Prezzi
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/prices
Parametri richiesti – GET
I dati di un singolo prezzo possono essere recuperati tramite l'ID del prezzo:
- https://verleihtool-url/api/prices/id
Valori di ritorno
| 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 |
Inventario biciclette
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/stock/bikes
Parametri richiesti – GET
I dettagli possono essere recuperati tramite l'ID dell'inventario:
- https://verleihtool-url/api/stock/bikes/id
Valori di ritorno
| 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 |
Inventario biciclette
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/stock/equipments
Parametri richiesti – GET
I dettagli possono essere recuperati tramite l'ID dell'inventario:
- https://verleihtool-url/api/stock/equipments/id
Valori di ritorno
| 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 |
Pedali
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/pedals
Aggiungere un pedale – POST
Inviare una POST-Request con i dati richiesti al seguente URL:
- https://verleihtool-url/api/pedals
Valori di ritorno
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | array | |
| sortindex | int | |
| show_frontend | boolean | |
| updated_at | date |
Hotels
Per accedere a questa risorsa, basta richiamare il seguente URL:
- https://verleihtool-url/api/hotels
Valori di ritorno
| Field | Type | Original Object |
|---|---|---|
| id | int (primary key) | |
| name | string | |
| show_frontend | boolean | |
| address | array |