Comment obtenir les données d'un odomètre via une API REST en utilisant Postman ? #OpenDevTalk7

3 mars 2023
Chez High Mobility, l'odomètre est le point de données le plus demandé et le plus populaire. Il est disponible pour toutes les marques coopérantes et permet un large éventail de cas d'utilisation : Les assureurs utilisent les données de l'odomètre pour les offres "Pay-As-You-Drive", les sociétés d'abonnement et de location de voitures automatisent la facturation en fonction des kilomètres parcourus, les outils d'analyse avancée tirent des enseignements impressionnants des kilométrages historiques et même les fournisseurs de carburant et de cartes de recharge ont enfin accès aux relevés réels de l'odomètre des véhicules électriques.

Obtenir le kilométrage actuel grâce aux données de la voiture connectée


La plupart des voitures sont équipées de systèmes télématiques embarqués qui permettent d'accéder facilement et à la demande à des informations en direct sur le véhicule. Par conséquent, il n'y a plus besoin de matériel supplémentaire tel que les dongles OBD2 pour mettre automatiquement à jour la valeur du compteur kilométrique dans les systèmes backend respectifs. High Mobility fournit une API harmonisée qui garantit que les données sont toujours fournies dans la même structure et le même format, quelle que soit la marque automobile utilisée. Comme notre solution est également entièrement conforme au GDPR, elle ouvre simplement la voie à une rationalisation de l'embarquement des clients et des conducteurs. 

Dans ce guide, nous démontrons comment vous pouvez accéder à notre point de données le plus populaire via l'API REST de High Mobility en utilisant l'outil Postman comme application commune pour les tests d'API. Nous supposons que vous savez déjà comment créer un compte High Mobility gratuit et comment configurer votre espace de travail avec un conteneur de données. En outre, nous supposons que l'application associée a été approuvée et que les véhicules ont été activés en conséquence. Si vous n'avez pas encore franchi ces étapes, nous vous recommandons vivement de consulter nos exposés Open Dev Talks "Comment démarrer avec les données des voitures connectées ?" et "Comment gérer le consentement et connecter les véhicules de la flotte". 

Afin de commencer à travailler avec l'API REST, nous vous recommandons de suivre chacune des étapes suivantes. Chaque aspect sous-jacent sera expliqué plus en détail à la fois dans la vidéo de notre 7e Open Dev Talk et dans ce billet de blog.

  • Configuration de l'environnement et de la collection Postman
  • Génération d'un jeton d'accès au véhicule
  • Récupérer les données de l'odomètre via le point de terminaison du statut du véhicule


Installation et configuration de Postman

Si vous n'avez pas encore téléchargé et travaillé avec Postman, veuillez obtenir l'application à partir de la source officielle et l'installer en conséquence. Si vous commencez à tester dans l'environnement Sandbox en utilisant notre simulateur de véhicule, vous pouvez commencer à télécharger la collection et l'environnement directement depuis notre plateforme. Allez sur high-mobility.com, connectez-vous à votre compte et ouvrez l'environnement "Build". Sélectionnez votre conteneur d'applications et récupérez les fichiers de configuration Postman correspondants directement dans l'onglet "Certificat client". Actuellement, cette option est disponible pour les applications à conducteur unique et la prise en charge des flottes sera également ajoutée dans un avenir proche. Alternativement, nous fournissons un accès à la collection et à l'environnement Postman correspondant pour les applications B2C et Fleet via GitHub.

Ensuite, ouvrez Postman et cliquez sur le bouton "Import". Sélectionnez à la fois l'environnement et le fichier de collection et confirmez en cliquant sur le bouton "Import". Dès que l'importation est terminée, vous verrez une longue liste de demandes et de points de terminaison sur le côté gauche.

L'étape suivante consiste à préparer l'environnement associé. Cliquez sur "Environnements" dans la barre de navigation de gauche et vous verrez que l'environnement pour le bac à sable de haute mobilité a déjà été établi à l'aide du processus d'importation. Si vous avez déjà commencé à utiliser de vraies voitures et l'environnement de production, vous pouvez simplement dupliquer l'environnement Sandbox. Allez dans votre conteneur d'applications et vérifiez que le paramètre APP_ID a été défini et que la valeur correspond à la valeur affichée en surbrillance dans le conteneur d'applications sur la plate-forme de la haute mobilité. Si elle n'est pas affichée dans l'aperçu, allez-y et ajoutez une nouvelle variable APP_ID et définissez la valeur actuelle à l'identifiant listé dans la section d'en-tête de votre conteneur d'applications. La variable REST_API_CONFIG doit contenir le snippet complet listé sous Certificats clients > API REST, la variable BASE_URL doit correspondre à la valeur api_url qui se trouve également dans le snippet API REST. Assurez-vous que le TOKEN_URI correspond à la valeur associée dans les paramètres du client OAuth de votre conteneur de données.

Génération du jeton d'accès au véhicule

Lorsque vous remettez un véhicule pour l'activer, vous recevez en retour un jeton d'accès. Ce jeton peut être utilisé ultérieurement pour appeler l'API et récupérer les données du véhicule, comme l'odomètre. Dans notre exemple, nous suivons la documentation relative à l'autorisation de la flotte pour l'adapter au contexte de notre cas d'utilisation type, ou bien nous examinons le flux de consentement de l'utilisateur B2C ici.

Dès que votre véhicule est activé, vous pouvez utiliser le point d'accès '.../fleets/acces_tokens' afin de récupérer un jeton d'accès pour votre véhicule. Ce point de terminaison requiert le numéro d'identification du véhicule (VIN) de votre véhicule cible et votre jeton d'authentification comme paramètres. Vous trouverez plus de détails sur la génération du jeton d'authentification dans notre session Open Dev Talk 5. L'exemple complet d'extrait de requête figure également dans notre guide technique.

Dès que vous aurez exécuté la demande, vous recevrez un jeton d'accès qui pourra être utilisé pendant toute sa durée de vie. En outre, la réponse mettra en évidence la portée des points de données de votre conteneur de données associé et le jeton de rafraîchissement qui peut être utilisé pour renouveler le jeton d'accès. Pour finaliser cette étape, vous pouvez simplement copier et coller le jeton d'accès dans le champ correspondant de l'environnement postman. Veillez à enregistrer les modifications avant de passer à l'étape suivante.

Obtenir des données d'odomètre via l'API REST

Dans la vue d'ensemble de vos collections, sur le côté gauche de Postman, vous remarquerez que les éléments de données des véhicules sont regroupés dans des catégories de terminaux. Puisque les données du compteur kilométrique sont associées à notre catégorie de diagnostic, vous pouvez simplement récupérer la valeur des données via ce point de terminaison. Cependant, nous recommandons généralement d'utiliser le point de terminaison Obtenir le statut du véhicule. Ce point de terminaison spécifique renverra toutes les valeurs disponibles en fonction de votre liste de points de données autorisés et activés, quelle que soit la catégorie.

Dès que vous sélectionnez le point de terminaison souhaité et que vous appuyez sur "Envoyer", Postman exécute la demande et affiche le résultat dans la vue des réponses. Chaque réponse met en évidence le VIN et le nom de la marque ainsi qu'une liste d'éléments de données accompagnés d'un horodatage (en UTC +0) afin de mieux comprendre quand la valeur des données a été générée dans le véhicule. Dans notre exemple, nous pouvons voir un kilométrage de 6871 kilomètres et, sur la base de l'horodatage, nous pouvons dire que le véhicule n'a pas été conduit au cours des deux derniers jours.

-------------------------------
Discussions Open Dev Talks de High Mobility.

Chez High Mobility, nous sommes passionnés par les nouvelles technologies. Nous proposons des outils open source gratuits et une documentation conviviale pour les développeurs afin que tous les projets puissent être intégrés facilement. Plus de 800 développeurs et chefs de produits se sont déjà inscrits sur notre plateforme communautaire modérée et nous organisons des concours de voitures connectées pour vos idées innovantes en la matière. 

Lors de notre session mensuelle gratuite en ligne Open Dev Talk de 30 minutes, nous expliquons en 15 minutes des sujets passionnants liés aux voitures connectées et consacrons le reste du temps à vos questions et idées.

Rejoignez notre communauté sur Slack