Jetons d'accès personnels
Les jetons d'accès personnels sont une approche alternative pour authentifier les requêtes API dans RAGNARØKKR PaaS, qui, par rapport à la méthode basée sur la session par défaut, offre une plus grande polyvalence et fiabilité.
Parmi les avantages des jetons, on peut souligner les suivants :
• Plusieurs jetons peuvent être générés en même temps pour supporter différentes tâches
• L’authentification simplifiée par jetons (pas besoin d'effectuer une ou plusieurs requêtes supplémentaires pour obtenir une session) assure une base de code plus petite et une réponse plus rapide lors de l'utilisation de scripts d'automatisation
• Vos identifiants (email et mot de passe) ne sont pas exposés dans les scripts
• Les jetons ne peuvent authentifier qu'une partie spécifique des fonctionnalités du compte, vous pouvez donc les partager avec des collègues et des assistants tiers sans créer de faille de sécurité
• Les jetons peuvent être complétés par la date d'expiration ou révoqués manuellement à tout moment
RAGNARØKKR fournit une interface visuelle entièrement fonctionnelle pour la gestion des jetons directement dans le tableau de bord, ce qui en fait le moyen privilégié pour authentifier toute intégration d'API (en particulier sur les comptes dont l'authentification à deux facteurs est activée).
Gestion des jetons d'accès
Ci-dessous, nous allons présenter le processus de gestion des jetons d'accès personnels à l'aide de l'interface utilisateur du tableau de bord :
1. Allez à la section Paramètres en cliquant sur le bouton du même nom dans le coin supérieur droit du tableau de bord (ou en cliquant sur votre identifiant > Paramètres).
2. Dans l’onglet ouvert, sélectionnez Jetons d'accès pour afficher la liste de tous les jetons du compte. Le panneau d'outils au-dessus de la liste permet d'accéder aux boutons suivants :
• Générer : crée un nouveau jeton en fournissant la description, la date d'expiration et en sélectionnant les méthodes API requises (soit à partir d'ensembles prédéfinis, soit manuellement)
• Editer : ajuste le jeton existant ou le régénère (c’est-à-dire définit un nouveau nom, tout en conservant tous les autres paramètres)
• Copier : crée un nouveau jeton en utilisant les paramètres du jeton existant comme base
• Supprimer : supprime le jeton sélectionné
• Actualiser : affiche les modifications les plus récentes de la liste
3. Lors de la création d'un nouveau jeton (en cliquant sur Générer) ou de l'ajustement du jeton existant (en cliquant sur Editer), l'image suivante s'affiche :
• Description : description personnalisée fournie pour le jeton
• Expire le : la date d’expiration du jeton au format jj-mm-aaaa (peut être régénéré après expiration)
• API : le nom de l'ensemble des requêtes API : prédéfinies (Extended Access, IDE Plugins, Marketplace, Maven Plugin) ou personnalisées (avec des méthodes sélectionnées manuellement)
• Utilisez le champ Recherche, le filtre Vérifié seulement et les liens vers les documents API (affichés lors du survol de la méthode particulière) pour configurer les autorisations requises pour le jeton
4. Tous les changements de jetons sur le compte nécessitent une confirmation obligatoire avec le mot de passe avant d'être appliqués.
5. Ensuite, vous verrez la valeur du jeton d'accès. Assurez-vous de l'avoir enregistrée (utilisez les boutons Télécharger/Copier), car elle ne s'affichera plus jamais nulle part.
Astuce : Si vous avez oublié ou perdu la valeur de votre token, il est possible d'en générer un nouveau en accédant à la fenêtre Editer Token d’accès (cliquez sur Editer pour y accéder) et en cliquant sur le lien approprié en bas.
L'ancienne valeur devient alors invalide, donc toute automatisation existante avec ce jeton doit être mise à jour.
6. Vous pouvez Supprimer les jetons dont vous n'avez plus besoin (utilisez Maj et Ctrl pour en sélectionner plusieurs) avec le bouton du même nom dans le panneau des outils.
Confirmez la suppression du ou des jetons et fournissez le mot de passe pour continuer.
Maintenant, vous savez comment gérer les jetons d'accès personnels sur le compte et vous pouvez les utiliser dans vos requêtes d'API.
Utilisation des jetons d'accès
L'utilisation de jetons d'accès simplifie considérablement l'authentification des requêtes API, car elle permet de sauter l'étape de génération des sessions et assure une plus grande fiabilité par rapport à la validité à court terme des sessions.
1. Il suffit d'exécuter la méthode API requise, en spécifiant votre jeton dans le paramètre de session.
Par exemple, vous pouvez arrêter un environnement en saisissant l'URL suivante dans un navigateur :
https://app.${platformDomain}/1.0/environment/control/rest/stopenv?envName=${envName}&session=${token}
• ${platformDomain} : URL de la plateforme (nom de domaine : rag-control.hosteur.com)
• ${envName} : nom de l'environnement cible (par exemple monprojet)
• ${token} : valeur du jeton (s'assurer qu'il a une permission pour l'opération appelée)
Pour une opération réussie, vous devriez obtenir un "result":0 en réponse (toute valeur non nulle représente une erreur).
2. Maintenant, si vous retournez au tableau de bord, vous verrez que l'environnement approprié s'est arrêté.
Voilà ! La gestion des API avec des jetons est aussi simple que ça !
