API de bike sharing : ce que tu peux intégrer avec Fleet OS (PMS, appli de l'immeuble et systèmes internes)

Réponse directe : l'API de Fleet OS, le logiciel avec lequel Cityflow exploite sa propre flotte, compte 46 endpoints REST avec authentification Bearer et un sandbox de test. Le PMS d'un hôtel, l'appli d'un immeuble ou ton ERP peuvent créer des réservations, enregistrer la remise et le retour du vélo, consulter la flotte et lire des indicateurs.

Cet article s'adresse aux opérateurs qui ont leur propre flotte. Si tu as un hôtel et que tu veux seulement des vélos pour tes clients, il n'y a rien à intégrer : dans les hôtels exploités par Cityflow, le client ouvre le vélo avec la clé NFC de sa chambre. Tout est sur vélos électriques pour hôtels.

Que contient exactement l'API de Fleet OS ?

Elle compte 46 endpoints répartis en six groupes. Tous passent par POST, avec le corps en JSON et la clé dans l'en-tête « Authorization: Bearer ». Les paramètres et les exemples sont dans la référence de l'API.

Les 27 endpoints de tables fonctionnent de la même façon : tu envoies le record_id et uniquement les champs qui changent.

Comment s'authentifier, et comment tester sans risque ?

Avec une clé d'API que Cityflow remet à la souscription de Fleet OS ; sans elle, la plateforme ne renvoie aucune donnée. Dès le premier jour, tu as un sandbox avec des données de test pour valider l'intégration sans toucher à de vrais vélos.

Les réponses du sandbox l'indiquent dans leur champ meta, et s'il manque un paramètre obligatoire, l'erreur dit lequel.

Comment connecter le PMS d'un hôtel ?

En appelant les endpoints de réservation depuis le PMS ou depuis un petit développement intermédiaire. Un flux possible :

1. Le client ajoute le vélo à son séjour : /create_advance_booking, avec son adresse e-mail, l'établissement, les dates et les vélos.
2. S'il annule son séjour : /cancel_booking.
3. À l'arrivée : /rental_checkin, qui renvoie le code de déverrouillage à lui montrer.
4. À la fin : /rental_checkout, qui clôture la location avec son décompte.
5. À tout moment, /get_booking donne l'état de la réservation.

Fleet OS n'écrit pas dans le PMS : pour imputer le montant sur la note de la chambre, ton développement transmet le décompte au PMS avec l'API du PMS lui-même, ou Cityflow le construit comme une intégration à part.

Et l'appli d'un immeuble ou d'une entreprise ?

Avec les mêmes endpoints. L'appli d'un immeuble que tu dessers affiche les vélos libres avec /get_vehicles_status et, avec /create_advance_booking et /rental_checkin, le résident réserve et reçoit son code sans la quitter.

Pour la flotte d'une entreprise, son intranet peut :

• inscrire chaque salarié avec /register_corporate_user, qui valide le domaine de l'adresse e-mail ;
• attribuer des droits par service ou par profil avec /set_employee_permissions ;
• réserver sur le campus avec /create_campus_reservation.

Que peut lire et écrire un ERP ou un système interne ?

Il peut lire des indicateurs et écrire l'état de la flotte. /get_master_overview donne la vue de tout ton réseau sur une période et /get_franchise_metrics la ventile par franchise ou par établissement. Plus de détails dans comment gérer plusieurs flottes depuis un tableau de bord unique.

Ton système d'atelier peut passer un vélo en maintenance, puis de nouveau en disponible, avec /update_bike_status. Les nouveaux vélos entrent avec /create_bike, avec leur modèle, leur établissement et leur type de cadenas. Fleet OS est compatible avec les cadenas Linka, AXA IN et Omni et avec l'IoT d'Acton et d'Okai : c'est dans le guide des cadenas intelligents et de l'IoT.

Les tables couvrent notamment les réservations, les paiements, les opérations de maintenance, les incidents et les utilisateurs.

Qu'est-ce qui ne figure pas dans l'API ?

Il manque trois choses qu'il vaut mieux savoir avant de concevoir l'intégration :

• Les notifications automatiques (webhooks). L'API ne prévient pas quand une location commence ou se termine : ton système interroge /get_booking ou /get_vehicles_status.
• Des connecteurs prêts à l'emploi pour un PMS précis. C'est ton équipe ou Cityflow qui les construit.
• L'écriture dans tes systèmes. Fleet OS répond à tes appels ; il n'écrit pas de lui-même dans ton PMS ni dans ton ERP.

Chacune se chiffre comme une intégration : 750 € pour une intégration standard ; les autres, sur proposition.

Combien coûte l'utilisation de l'API ?

Rien de plus : l'accès est inclus dans l'abonnement Fleet OS, soit 300 € par mois plus de 8 € à 3 € par véhicule selon la tranche, avec 1 000 € de frais d'activation et sans engagement. Seules les intégrations avec du matériel ou des systèmes que Fleet OS n'intègre pas de série se paient à part, 750 € pour une intégration standard. Le détail est dans les tarifs de Fleet OS.

Comment démarrer ?

1. Lis la référence de l'API et note les endpoints utiles pour ton cas.
2. Demande une démo et dis à Cityflow quels systèmes tu veux connecter.
3. À la souscription, tu reçois la clé et le sandbox, et ton équipe valide l'intégration.

Fleet OS est le logiciel avec lequel Cityflow exploite sa flotte dans 9 provinces, et des opérateurs du secteur roulent déjà avec. Pour en savoir plus, va sur la page de Fleet OS, où tu peux aussi demander une démo.

Questions fréquentes

Combien d'endpoints compte l'API de Fleet OS ?

46 endpoints REST avec authentification Bearer et un sandbox avec des données de test, répartis en six groupes ; 27 d'entre eux servent à modifier les tables champ par champ. La référence complète est publiée sur cityflow.app/software/api.

Peut-on connecter Fleet OS au PMS d'un hôtel ?

Oui : le PMS, ou un développement intermédiaire, appelle les endpoints de réservation pour créer la réservation, enregistrer la remise avec son code de déverrouillage, clôturer la location avec son décompte ou l'annuler. Fleet OS n'a pas de connecteur prêt à l'emploi pour un PMS précis : si Cityflow le construit, c'est une intégration à part, 750 € pour une intégration standard.

L'API de Fleet OS prévient-elle mon système quand une location commence ou se termine ?

Non : la référence n'inclut pas de notifications automatiques (webhooks). Ton système consulte l'état avec /get_booking ou /get_vehicles_status ; si tu as besoin que Fleet OS prévienne, ça se chiffre comme une intégration.

Combien coûte l'accès à l'API de Fleet OS ?

Il est inclus dans l'abonnement Fleet OS : 300 € par mois plus de 8 € à 3 € par véhicule selon la tranche, et 1 000 € de frais d'activation, sans engagement. Les intégrations avec du matériel ou des systèmes que Fleet OS n'intègre pas de série coûtent 750 € pour une intégration standard.

Puis-je tester l'intégration sans toucher à ma vraie flotte ?

Oui. Dès le premier jour, tu as un sandbox avec des données de test, et ses réponses l'indiquent dans le champ meta. Ton équipe valide chaque étape avant de la connecter aux vrais vélos.