auth_token.md
Gestion des jetons de connexion
Un jeton de connexion est une manière de permettre un accès à l'application, via le compte de la personne qui posssède le jeton, sans avoir à fournir ses identifiants.
L'avatange d'un jeton est qu'il ne donne aucune informations sur l'utilisateur à la personne, et peut être désactivé à tout moment.
Utilité
Le jeton de connexion permet de faire tout ce que l'utilisateur lié au jeton peut faire, et est au centre de plusieurs fonctionnalités :
- Il permet l'utilisation de l'API
- Il permet d'utiliser le mode publique de vMap2, en étant connecté à l'application via cet utilisateur.
- Il permet d'utiliser les widgets.
Création
Il est possible de créer un token dans l'interface prévue à cet effet, à l'emplacement "Utilisateurs" > "Jetons de connexion", puis de cliquer sur le bouton "Ajouter" pour un ajouter un nouveau jeton de connexion.
Il suffit ensuite de remplir les différents champs du formulaire pour créer le token :
Utilisation
Utilisation de l'API avec un jeton
Il est possible, via un jeton utilisateur, de récupérer un jeton de connexion, permettant d'utiliser l'API de vMap2.
Pour ce faire, il faut tout d'abord récupérer le champ ID
au niveau du token dans la liste :
Il est ensuite possible d'obtenir un token d'authentification en requêtant la route vitis/privatetoken
avec le jeton dans l'header Authorization
:
Celui-ci peut ensuite être utilisé dans le reste des routes de l'API, dans le token Authorization
, et permet de se servir de l'API comme une connection utilisateur/mot de passe classique :
Connexion au mode publique
Une autre des utilités des jetons est la mise en place du mode publique.
En effet, le mode publique nécessite un jeton de connexion afin de pouvoir connecter l'utilisateur invité à l'application.
Pour ce faire, il suffit de paramétrer deux propriétés, dont une nécessitant le jeton de connexion :
{
...
"public_connect_enabled": false,
"public_connect_token": "",
...
}
Une fois ces informations mises en place, il est possible d'accéder à l'application sans connection de l'utilisateur.
:alt: mode_publique
:align: center
Exemple d'application avec le mode publique
Création d'un widget carte
Dans vMap2, il est également possible de créer un widget carte qui permet d'intégrer des cartes dans d'autres sites WEB.
Pour ce faire, il est absolument nécessaire d'avoir un jeton de connexion existant.
Pour créer un widget, il Faut se rendre dans "Cartes et Couches" > "Cartes".
Il faut ensuite appuyer sur le crayon au niveau de la carte choisie, puis sur le formulaire
Une fois sur le formulaire d'édition de la carte, il faut se rendre dans le sous-menu "appel externe" et ajouter un nouvel enregistrement :
Une fois dans l'interface d'ajout, il suffit de remplir les différentes informations, en choisisant le bon token dans la liste déroulante.
Une fois le formulaire validé, le code pour intégrer la carte est disponible dans une nouvelle fenêtre dans le formulaire :