Introduction à OData
OData (Open Data Protocol) est un standard ouvert (approuvé par OASIS et ISO) pour interroger et manipuler des données via des APIs REST. Son grand avantage est qu'il définit des conventions d'URL pour filtrer, trier, paginer, sélectionner des champs et étendre des relations — sans avoir à créer un endpoint sur mesure pour chaque combinaison.
En pratique : au lieu de demander au backend « donne-moi les réservations du client X créées ce
mois-ci, seulement avec le code et la date », vous construisez vous-même cette requête depuis l'URL avec des paramètres
standard ($filter, $select, $orderby, etc.).
- Documentation OData sur Microsoft Learn — guide complet du protocole et de la librairie utilisée par Rently (ASP.NET OData).
- Site du standard OData (odata.org) — spécification, conventions d'URL et exemples.
- Conventions d'URL d'OData v4 — référence détaillée de
$filter,$expand, etc.
OData chez Rently
Rently expose une API OData en lecture seule sur un ensemble d'entités de référence/consultation, pensée pour les intégrations qui ont besoin de consulter et de produire des rapports sur des données de manière flexible (filtres, agrégations, exports) sans multiplier les appels.
- Base URL : toutes les ressources OData se trouvent sous
https://{tenant}.rently.com.ar/odata. - Authentification : la même que le reste de l'API — token Bearer dans le header
Authorization(voir Authentification). - Lecture seule : les endpoints OData supportent
GET(collection et par key). Les opérations d'écriture (créer/mettre à jour des réservations, paiements, etc.) se font via l'API REST.
Entity sets disponibles
| Entity set | Ressource | Description |
|---|---|---|
| Bookings | /odata/Bookings | Réservations (supporte $expand de Customer, Category, etc.). |
| Customers | /odata/Customers | Clients. |
| Agencies | /odata/Agencies | Agences. |
| Categories | /odata/Categories | Catégories de véhicules. |
| Models | /odata/Models | Modèles de véhicules. |
| Places | /odata/Places | Agences / emplacements. |
| BookingBrands | /odata/BookingBrands | Marques de booking. |
OData ou REST ?
- Utilisez OData lorsque vous devez consulter/filtrer/produire des rapports sur ces entités avec flexibilité (par exemple, lister les réservations d'un client sur une plage de dates, en étendant ses données, en ne récupérant que certains champs).
- Utilisez l'API REST (les modules Bookings, Customers, etc.) pour opérer : créer et gérer des réservations, enregistrer des paiements, check-in/out, incidents, etc.
Continuez avec Construire des queries OData pour voir comment filtrer, étendre et trier avec des exemples réels.