Einführung in OData
OData (Open Data Protocol) ist ein offener Standard (von OASIS und ISO genehmigt) zum Abfragen und Manipulieren von Daten über REST-APIs. Sein großer Vorteil ist, dass er URL-Konventionen definiert, um zu filtern, zu sortieren, zu paginieren, Felder auszuwählen und Beziehungen zu expandieren — ohne für jede Kombination einen maßgeschneiderten Endpunkt anlegen zu müssen.
In der Praxis: Statt das Backend zu bitten, "gib mir die Buchungen von Kunde X aus diesem
Monat, nur mit Code und Datum", bauen Sie diese Abfrage selbst aus der URL mit Standardparametern
($filter, $select, $orderby usw.).
- OData-Dokumentation auf Microsoft Learn — vollständiger Leitfaden zum Protokoll und zur von Rently verwendeten Bibliothek (ASP.NET OData).
- Website des OData-Standards (odata.org) — Spezifikation, URL-Konventionen und Beispiele.
- URL-Konventionen von OData v4 — detaillierte Referenz zu
$filter,$expandusw.
OData bei Rently
Rently stellt eine schreibgeschützte OData-API über einen Satz von Referenz-/Abfrageentitäten bereit, gedacht für Integrationen, die Daten flexibel abfragen und auswerten müssen (Filter, Aggregationen, Exporte), ohne mehrere Aufrufe.
- Basis-URL: Alle OData-Ressourcen liegen unter
https://{tenant}.rently.com.ar/odata. - Authentifizierung: dieselbe wie bei der übrigen API — Bearer-Token im Header
Authorization(siehe Authentifizierung). - Nur Lesen: Die OData-Endpunkte unterstützen
GET(Collection und nach Key). Schreiboperationen (Buchungen erstellen/aktualisieren, Zahlungen usw.) erfolgen über die REST-API.
Verfügbare Entity-Sets
| Entity-Set | Ressource | Beschreibung |
|---|---|---|
| Bookings | /odata/Bookings | Buchungen (unterstützt $expand von Customer, Category usw.). |
| Customers | /odata/Customers | Kunden. |
| Agencies | /odata/Agencies | Agenturen. |
| Categories | /odata/Categories | Fahrzeugkategorien. |
| Models | /odata/Models | Fahrzeugmodelle. |
| Places | /odata/Places | Filialen / Standorte. |
| BookingBrands | /odata/BookingBrands | Booking-Marken. |
OData oder REST?
- Verwenden Sie OData, wenn Sie diese Entitäten flexibel abfragen/filtern/auswerten möchten (zum Beispiel die Buchungen eines Kunden in einem Datumsbereich auflisten, seine Daten expandieren, nur einige Felder abrufen).
- Verwenden Sie die REST-API (die Module Bookings, Customers usw.), um zu operieren: Buchungen erstellen und verwalten, Zahlungen erfassen, Check-in/out, Vorfälle usw.
Fahren Sie mit OData-Queries erstellen fort, um zu sehen, wie Sie mit echten Beispielen filtern, expandieren und sortieren.