Dans le cadre de la création de nouvelles clés API de développeur ou de la modification des clés API de développeur existantes dans votre compte, vous pouvez personnaliser l'accès que reçoit la clé API. Ces modifications permettent aux administrateurs de contrôler l'accès direct et les points finaux spécifiques de l'API pour un outil tiers associé à leur institution.
Par défaut, le respect de la portée est désactivée lors de la création d'une nouvelle clé API de développeur, ce qui permet aux jetons d'accéder à tous les points finaux disponibles pour l'utilisateur autorisant l'accès. Cependant, les portées peuvent être modifiées pour une clé API de développeur à tout moment afin de mettre à jour les jetons d'accès de l'utilisateur autorisant l'accès de manière appropriée.
Remarques :
- La gestion des clés de développeur est une autorisation de compte. Si vous ne pouvez pas gérer les clés de développeur, cette autorisation n'a pas été activée pour votre rôle d'utilisateur.
- Les clés de développeur ne sont pas disponibles dans les sous-comptes.
Ouvrir un compte
Dans Navigation globale, cliquez sur le lien Admin [1], puis sur le nom du compte [2].
Ouvrir les clés de développeur
Dans la navigation du compte, cliquez sur le lien Clés de développeur (Developer Keys).
Ajouter une clé de développeur
Cliquez sur le bouton Ajouter une clé de développeur (Add Developer Key).
Ajouter la clé API
Cliquez ensuite sur l'option Ajouter la clé API (Add API Key).
Respecter les portées
Après avoir complété les informations sur la clé de développeur, cliquez sur le bouton Respecter les portées (Enforce Scopes).
Autoriser les paramètres Inclure
Pour autoriser l'utilisation de tous les paramètres « inclure » pour cette clé, cochez la case Autoriser les paramètres Inclure (Allow Include Parameters).
Les paramètres « Inclure » peuvent accorder l'accès à des données supplémentaires qui ne sont pas incluses dans le tableau des points finaux.
Rechercher les points finaux
Pour rechercher un point final spécifique, saisissez le nom du point final dans le champ Rerchercher les points finaux (Search Endpoints) [1].
Pour voir tous les points finaux disponibles, faites défiler le tableau des points finaux [2].
Sélectionner les points finaux en lecture seulement
Pour accorder un accès en lecture seulement (GET) à la clé de développeur, cochez la case Lecture seulement (Read only). Le tableau sera automatiquement mis à jour et sélectionnera toutes les portées contenant des points finaux en lecture seulement.
Sélectionner des points finaux individuels
Vous pouvez accorder un accès personnalisé à la clé API du développeur. Cliquez sur n'importe quel nom de portée pour afficher les points finaux disponibles [1]. Sélectionnez les points finaux souhaités en cochant la case en regard du nom du point final [2]. La ligne du nom de la portée sera mise à jour pour afficher le résumé de l'accès collectif au point final sélectionné [3].
Enregistrer la clé
Cliquez sur le bouton Enregistrer (Save).
