Plateforme Vehizen Client/ paramètres d'url
Plateforme_Vehizen_Client_paramètres_url
- access_token : Permet l'authentification à l'api sans passer par la page login et donc sans se faire déconnecté, une fois authentifié le token sera stocké dans le localStorage et donc accessible depuis l'auteur de l'iframe.
- hideArbo : paramètre pour masquer ou non l'arbo, doit être renseigné à 1. Attention l'arbo est l'outil idéal pour naviguer entre les entités du client final.
- hideMenu : paramètre pour masquer le menu de navigation vers les modules, doit être renseigné à 1, attention le menu réapparaitra on hover sur les premiers pixel tout en haut de la page.
- forceHideMenu : paramètre pour forcer le masquage du menu, doit être renseigné à 1, le menu ne réapparaitra jamais, fait pour avoir une page statique.
- idPath : chemin d'accès à la ressource grâce à quoi nous faisons la requete derrière exemple pour tous les véhicules : root%7CVehicles "%7C" étant le code pour "|", pour une agence : root%7CVehicles%7CAgence%3D79b47e55-ab6c-4811-b3b2-349c37957610, "%3D" étant "=" et après il y'a le Guid de l'agence en question (ici Calsat chez camperi), Pour un véhicule : Vehicle%3D1a328b23-b0aa-478f-8220-ea418c04d848. Etc pour plus d'info demander à Nico/ Karim/ Yohann/ Vincente dans l'ordre ou alors naviguer dans le client pour voir le formatage des idPath
- dateStart/ dateEnd : date en string sur lesquels on va faire la requête du module exemple : dateStart=Sun%20Feb%2001%202026%2000:00:00%20GMT%2B0100%20(heure%20normale%20d’Europe%20centrale)&dateEnd=Sat%20Feb%2028%202026%2023:59:59%20GMT%2B0100%20(heure%20normale%20d’Europe%20centrale), "%20" étant un espace, %2B étant le + des date en UTC => 01 Février 2026 jusqu'au 28 février 2026
Cette documentation à pour but de renseigner les différentes manières et modules accessibles depuis l'extérieur avec simplement une URL qui redirige pile poil au bon endroit
Liste de paramètres d'url
En principe les modules ont chacun une préférence pour idPath et les dates (le site les rajoute automatiquement), mais ce n'est pas toujours le cas (à voir à l'utilisation).
Si un idPath est renseigné et l'arbo visible, l'arbo se déroulera automatiquement jusqu'à la feuille ou groupe sélectionné, de préférence voir comment réagit le module sans ce paramètre mais voir surtout pour en avoir déjà un de renseigné si c'est possible.
Liste des modules exploitable :
- Eco-conduite : contient les informations sur la manière de conduire des véhicule ou conducteurs
Page liste URL : /Eco-conduite : (même chose pour conducteurs)
Page détail URL : /Eco-conduite/{:type(vehicle/ driver)}/{:id(du véhicule ou du driver)} : (même chose pour conducteur)
- Rapport : contient des informations sur les journées de travail (doit avoir un idPath qui pointe vers une feuille (un conducteur ou un véhicule et non un groupe))
Page liste : URL : /Rapport/Groupe, avec idPath qui pointe vers une feuille et non un groupe : ici un mois est sélectionné dans l'arbo, ou fournit dans l'url avec dateStart et dateEnd
Page détail : URL : /Rapport/{Véhicule / Conducteurs / Zone}, avec idPath qui pointe vers une feuille et non un groupe
Ici un paramètre est utilisable : "displayedTab" qui peut contenir les différents sous-onglet (Activtés => activities, Courbes => speedLine, Synthèse => synthese, Rapport => grid, Événements => events, Carte => map). Exemple: displayedtabs=map,speedLine,synthese. Si renseigné n'affiche pas le menu des sous-onglets
- Données sociales : contient les informations sur les activités, indémnités, absences, infractions
Page Liste : URL : /Données sociales/{sous-onglet}, ici les sous-onglets peuvent être Synthèse, Projection, Absences et l'affichage de la liste sera différente, attention, l'arbo ne contient que des conducteurs donc idPath ne peut que être par rapports aux conducteurs
Page détail : URL : /Données sociales/{id}/{sous-onglet}, ici les sous-onglets peuvent être Activités, Indemnités, Absences, Infractions
note : ici l'idPath de la page détail ne correspond pas à l'idPath du conducteur (Abdelkamel Younes) car son id est récupéré dans l'url directement
- Flotte : Contient les informations sur lee parc automobile, attention l'arbo ne contient que des véhicules
Page Listes : URL : /Flotte/{sous-onglet}, ici les sous-onglets peuvent être Parc, Santé, Gestion des plans de maintenance, Gestion des opérations, aucune page détail accessible
- Pour tous les autres modules il n'y aucune spécificité particulière, juste se balader sur le module devrait suffire pour comprendre son utilité
- Comptes et rôles
On peut créer des comptes sur mesure avec seulement quelque module de visible pour à la fois garder une navigation entre les modules de manière plus contrôlé, à faire de préférence