Portail du gestionnaire
      Revenir à l'accueil
      1. Base de connaissances
      2. Portail du gestionnaire

      Gestion des clés d'accès

      Guide des fonctionnalités du produit

      Table of Contents


      Introduction

      Gestion des clés d'accès Articles, leur description et fonctionnalité

      Création d'une nouvelle clé d'accès

      Suppression une clé d'accès

      Usage

      Introduction

      La section Gestion des clés d'accès permet aux équipes techniques de créer et de gérer leur liste de clés d'accès au sein de l'application pour les projets d'intégration d'API (l’interface de programmation d'application). Les clés d'accès se composent de deux parties : un ID de clé d'accès et un secret de clé d'accès. Il est nécessaire d'utiliser à la fois l'ID de la clé d'accès et le secret de la clé d'accès pour authentifier vos demandes. Une interface de programmation d'application (API) est un ensemble de règles et de protocoles qui définissent la manière dont les programmes logiciels peuvent interagir les uns avec les autres. Les API permettent à différents systèmes logiciels de communiquer entre eux et d'échanger des données et des fonctionnalités. Ils constituent une autre façon de se connecter à notre application et sont spécifiques aux intégrations. Les clés d'accès peuvent uniquement être créées ou supprimées ; elles ne peuvent pas être modifiées une fois créées. 

      La gestion des clés API se fait via le Manager Portal :

      1. Sélectionnez Portail du gestionnaire dans le menu supérieur.
      2. Sélectionnez « Gestion des clés d'accès » dans la barre latérale gauche.

      Gestion des clés d'accès Articles, leur description et fonctionnalité

        

      Zone de recherche - Dans la zone de recherche, vous pouvez saisir du texte/mots-clés liés aux clés d'accès précédemment créées. Toutes les clés d'accès contenant les critères de recherche apparaîtront dans une liste.

      Bouton « Ajouter une nouvelle clé d'accès » - Vous permet d'ajouter une nouvelle clé d'accès à la liste. 

      Trier la liste des clés d'accès - Les colonnes peuvent être triées par ordre croissant ou décroissant en cliquant sur la flèche à droite du titre de l'en-tête.  Lorsque la flèche est tournée vers le haut, la liste est triée par ordre croissant.  Lorsqu'elle est orientée vers le bas, la liste est triée par ordre décroissant. Lorsque vous trierez la liste, la flèche dans la colonne dans laquelle vous avez trié restera en place pour indiquer quels étaient vos critères de tri. 

      Ascendant:

      Descendant:

      Identifiant client - L'ID client est automatiquement généré par le système et s'affiche dans la liste lorsqu'une nouvelle clé d'accès est ajoutée. Un ID client est un identifiant associé à une application qui aide à l'authentification client/serveur pour les API client. Les développeurs créent un ID client en définissant une application sur leur tableau de bord de développeur.

      Secret client - Le Client Secret est automatiquement généré par le système et affiché dans la liste lorsqu'une nouvelle clé d'accès est ajoutée. Cette clé est utilisée pour identifier votre compte. Vous pouvez trouver votre clé secrète API dans la page API de votre tableau de bord. Vous pouvez également créer de nouvelles clés API dans la même section si nécessaire.

      Description - Description de la clé d'accès. Ce champ est facultatif lors de l'ajout d'une nouvelle clé d'accès. Cette description peut aider à identifier le projet appelant.

      Prénom du propriétaire - Prénom du propriétaire de la clé d'accès.

      Nom de famille du propriétaire - Nom de famille du propriétaire de la clé d'accès.

      E-mail du propriétaire - Email du propriétaire de la clé d'accès.

      Numéro de téléphone du propriétaire - Numéro de téléphone du propriétaire de la clé d'accès.

      Créé à - Ce champ est automatiquement rempli avec la date et l'heure auxquelles la clé d'accès a été ajoutée à la liste.

      Points de suspension - Cliquer sur les points de suspension ouvre la possibilité de supprimer une clé d'accès si nécessaire. 

      Barres de défilement - Situé en bas de la liste des clés d'accès et à l'extrême droite de l'écran.  Utilisez-les pour faire défiler horizontalement et verticalement afin d'afficher le contenu qui peut ne pas tenir entièrement sur la page.  

      Articles par page - Selon la taille de votre liste, vous pouvez avoir plus d'une page de clés d'accès. Pour parcourir les pages, utilisez la navigation « Articles par page » en bas à droite de votre écran. Avec cette fonctionnalité, vous pouvez indiquer combien d'éléments par page vous souhaitez voir en groupes de 10, 15, 25, 50 ou 100. Vous pouvez également voir combien de pages il y a et faire défiler les pages vers l'avant et vers l'arrière si nécessaire. 

      Création d'une nouvelle clé d'accès 

      Pour ajouter une nouvelle clé d'accès :

      1. Sélectionnez le bouton Ajouter une nouvelle clé d’accès.
      2. Saisissez les champs obligatoires de la clé (prénom du propriétaire, nom de famille du propriétaire, e-mail du propriétaire et numéro de téléphone du propriétaire).
      3.  Cliquez sur le bouton « Créer une clé » pour ajouter la clé d'accès à la liste.

      Remarque : Le secret client ne peut être copié qu'à cette étape, après quoi il sera masqué (********). FundMore n'en stocke qu'une version hachée, donc si la clé API est perdue, vous devrez en générer une nouvelle (et supprimer celle perdue du portail du gestionnaire).

      Remarque : Les clés d'accès ne peuvent pas être modifiées une fois créées.

      Suppression une clé d'accès

      Pour supprimer une clé d'accès de la liste, cliquez sur l'icône de points de suspension située à côté de la clé que vous souhaitez supprimer. Ensuite, sélectionnez l’option « Supprimer » dans le menu qui apparaît. La clé d'accès sera supprimée de la liste.

      Remarque : lorsqu'une clé d'accès est supprimée, vous ne pourrez plus l'utiliser. Assurez-vous de supprimer uniquement les clés d'accès qui ne sont utilisées par aucun système.

       

      Usage

      Authentification (2 appels API)

      Étape 1 : Authentifier la clé API

      corps

      {

        "authFlow": "resource_owner_password",

        "authParamètres": {

          "provider": "api_access_key",

          "ClientId" : ${clientId},

          "clientSecret" : ${clientSecret}

        }

      }

       

      • ${IDclient} - obtenir à partir du portail du gestionnaire
      • ${clientSecret} - obtenir depuis le portail du gestionnaire

      Requête HTTP POST :

      • taper: ${apiUrl}/auth/authentification
      • corps: corps

      demande:

      {

        "authFlow": "resource_owner_password",

        "authParamètres": {

          "provider": "api_access_key",

          "clientId": "******", //GUID

          "clientSecret": "********" //CHAÎNE

        }

      }

       

      réponse:

      {

          "résultat d'authentification": {

              "accessToken": "******", // CHAÎNE JWT

              "idToken": "******", //CHAÎNE JWT

              "refreshToken": "******", // CHAÎNE JWT

              "tokenType": "porteur"

          }

      }

       

      idToken sera nécessaire lors de l'appel API suivant

      Étape 2 : Contexte de la portée du problème

      en-têtes

      {

        'autorisation' : ${idToken}, // idToken du résultat de l'autorisation précédente

        'accepter' : 'application/json'

      }

       

      • ${idToken} - obtenir de l'appel API d'authentification précédent

      Requête HTTP GET :

      • taper: ${apiUrl}/api/auth/scope-context
      • en-têtes : en-têtes

      réponse:

      {

          "scopeContextToken": "******" // Jeton JWT

      }