Aller au contenu

API Car Sharing

Version actuelle : 1.13

Dernière mise à jour du contenu : 27/10/2025. Voir le changelog pour l'historique des versions.

L'API Car Sharing (autopartage & sécurité) permet de gérer de manière centralisée la sécurisation et l'accès aux véhicules d'une flotte : véhicules, boîtiers télématiques, autorisations d'accès Bluetooth, actions à distance, statuts, réservations, stationnements et données SIV.

Utilisation de l'API

L'API Car Sharing est une API REST. Le format d'échange utilisé par l'API est le JSON.

Cette API est à destination des applications de gestion de l'autopartage ou de sécurisation des véhicules. Le conducteur utilise sa connexion Bluetooth pour accéder au véhicule ou activer/désactiver des fonctions de sécurité — se référer à la documentation Bluetooth correspondant au modèle de boîtier installé pour plus de détails.

Codes HTTP

Code Description
200 La requête a réussi.
401 L'authentification a échoué. Vérifiez l'appId et l'appKey fournis.
403 Accès non autorisé. Le token fourni n'est pas valide.
404 Donnée non trouvée. L'identifiant de la donnée (véhicule, boîtier, autorisation, plaque d'immatriculation) est inconnu.
480 La requête n'a pas pu aboutir. Vérifiez le champ error contenu dans la réponse de l'API pour plus d'information.
500 Erreur interne.

Dans cette documentation

  • Authentification — obtenir, rafraîchir un token, gérer le mot de passe utilisateur.
  • Endpoints — véhicules, boîtiers, accès Bluetooth, actions, statuts, autorisations, réservations, stationnements, données SIV.
  • Erreurs — codes d'erreur renvoyés dans le champ error.
  • Changelog — historique des versions de cette documentation.