Interaction des utilisateurs avec votre portail

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Le portail des développeurs prêt à l'emploi permettre aux utilisateurs de votre portail de créer un compte utilisateur, de se connecter et de gérer les applications qui consommeront vos API.

Les sections suivantes décrivent comment les utilisateurs du portail interagissent avec votre portail.

Se connecter au portail

Les sections suivantes décrivent comment les utilisateurs du portail se connectent au portail intégré à l'aide de leurs identifiants d'utilisateur (fournisseur d'identité intégré) ou de SAML (version bêta).

Si vous activez les fournisseurs d'identité intégrés et SAML, les utilisateurs du portail pourront choisir leur méthode de connexion préférée.

Se connecter au portail à l'aide des identifiants d'utilisateur (fournisseur d'identité intégré)

Remarque : La page de connexion ne peut être modifiée que par la modification du logo de l'entreprise, comme décrit dans la section Configurer l'expérience de création de compte utilisateur et de connexion.

Lorsque le fournisseur d'identité intégré est activé, les utilisateurs du portail peuvent se connecter au portail intégré à l'aide de leurs identifiants (nom d'utilisateur et mot de passe), comme décrit dans les sections suivantes :

• Créer un compte utilisateur sur le portail intégré
• Se connecter au portail intégré
• Modifier le mot de passe

Créer un compte utilisateur sur le portail intégré

Avec le fournisseur d'identité intégré, les utilisateurs du portail doivent créer un compte utilisateur sur le portail intégré pour pouvoir utiliser vos API.

Point important : Consultez également la section Emplacement de stockage des informations de compte de développeur d'applications.

Bien qu'il soit possible de créer manuellement des comptes utilisateur pour le compte d'utilisateurs du portail à l'aide de l'interface utilisateur de gestion Edge, comme décrit sur la page Enregistrer des développeurs d'applications, cette opération n'est pas recommandée afin de s'assurer que les comptes utilisateur sur le portail intégré et les enregistrements des développeurs sur Edge restent synchronisés.

Les utilisateurs du portail créent un compte sur le portail intégré comme suit :

1. Accédez au portail.

2. Cliquez sur Sign In.

   La page de connexion s'affiche.

3. Cliquez sur Créer un compte.

   La page "Créer votre compte" s'affiche.

   

   Remarque : Vous pouvez ajouter des champs d'enregistrement personnalisés à la page de création de compte, comme décrit dans la section Ajouter des champs d'enregistrement personnalisés à la page de création de compte.

4. Remplissez le formulaire.

   Vous devez saisir des valeurs dans tous les champs obligatoires. Les mots de passe doivent comporter au moins huit caractères et contenir au moins l'un des éléments suivants : chiffre, lettre minuscule, lettre majuscule et caractère spécial.

5. Lisez et acceptez les conditions d'utilisation.

6. Cliquez sur Create Account (Créer un compte).
   

   Remarque : En cas de tentative de création d'un compte avec une adresse e-mail déjà enregistrée, un message indiquant que le compte existe déjà s'affiche, et l'utilisateur du portail est invité à se connecter.
   1. Remplissez le formulaire CAPTCHA et cliquez sur le bouton Verify (Vérifier), s'il s'affiche.

   Le compte utilisateur est créé, et un e-mail de confirmation est envoyé.

   Remarque : Vous pouvez configurer l'e-mail de confirmation, comme décrit dans la section Configurer des notifications par e-mail. Apigee vous recommande de configurer le serveur SMTP utilisé pour les notifications par e-mail provenant du portail avant le lancement, comme décrit dans la section Configurer le serveur SMTP.

7. Dans les 10 minutes, cliquez sur le lien inclus dans l'e-mail de confirmation pour terminer l'inscription.

   Si vous ne cliquez pas sur le lien dans les 10 minutes, vous devez répéter les étapes de cette procédure pour créer un compte et recevoir l'e-mail de confirmation à nouveau.

8. Connectez-vous au portail intégré (décrit ci-dessous).

Se connecter au portail intégré

Avec le fournisseur d'identité intégré, une fois les utilisateurs du portail enregistrés sur le portail intégré et ont été approuvés, ils se connectent à l'aide de leurs identifiants (nom d'utilisateur et mot de passe).

Remarques :

• Au bout de 24 heures d'inactivité, la session expire et l'utilisateur du portail est automatiquement déconnecté et doit se reconnecter.
• Si vous avez configuré votre portail intégré pour exiger l'activation manuelle des comptes utilisateur, vous devez activer manuellement les comptes utilisateur pour que les utilisateurs du portail puissent se connecter. Pour le moment, aucun utilisateur du portail ne peut indiquer que son enregistrement doit être activé manuellement avant de pouvoir se connecter. Si vous configurez l'activation manuelle, il est recommandé d'accélérer l'activation de nouveaux comptes utilisateur.
• Pour accéder directement à la page de connexion, utilisez l'URL suivante :
  https://portal-url/login

Les utilisateurs du portail se connectent comme suit :

1. Accédez au portail.
2. Cliquez sur Sign In.
   La page de connexion s'affiche :
   
3. Saisissez l'adresse e-mail et le mot de passe.
4. Cliquez sur Sign In.

Modifier le mot de passe

Avec le fournisseur d'identité intégré, les utilisateurs du portail modifient le mot de passe comme suit :

1. Accédez au portail.
2. Cliquez sur Sign In.
3. Cliquez sur Réinitialiser le mot de passe.
4. Saisissez l'adresse e-mail du compte à réinitialiser.

5. Cliquez sur Envoyer le lien de réinitialisation du mot de passe.

   Un lien permettant de réinitialiser le mot de passe est envoyé à l'adresse e-mail.

   Remarque : Pour configurer le serveur SMTP, consultez la section Configurer le serveur SMTP.

6. Cliquez sur le lien figurant dans l'e-mail de confirmation.

7. Saisissez le nouveau mot de passe et confirmez-le.

   Les mots de passe doivent comporter au moins huit caractères et contenir au moins l'un des éléments suivants : chiffre, lettre minuscule, lettre majuscule et caractère spécial.

8. Cliquez sur Créer un mot de passe.

Se connecter au portail à l'aide de l'authentification SAML (version bêta)

Remarque : Il s'agit de la version bêta du fournisseur d'identité SAML.

Remarque : La page de connexion ne peut être modifiée que dans le but de modifier le logo de l'entreprise, comme décrit dans Configurer l'expérience de création de compte utilisateur et de connexion.

Lorsque le fournisseur d'identité SAML est activé, les utilisateurs du portail se connectent au portail intégré à l'aide de l'authentification SAML, comme suit :

1. Accédez au portail.
2. Cliquez sur Sign In.

3. Cliquez sur Se connecter avec SAML.

   Vous êtes redirigé vers le fournisseur SAML.

4. Si vous y êtes invité, saisissez vos identifiants pour votre fournisseur d'identité SAML.

Remarque : Au bout de 24 heures d'inactivité, la session expire, et l'utilisateur du portail est automatiquement déconnecté et doit se reconnecter.

Consulter la documentation de référence sur l'API

Les utilisateurs du portail peuvent afficher la documentation de référence de l'API que vous avez publiée sur votre portail, en procédant comme suit :

1. Accédez au portail.

2. Cliquez sur APIs dans la barre de navigation supérieure.
   La page des API s'affiche. Par exemple,
   
   

3. Si vous le souhaitez, filtrez la liste des API par catégorie, titre ou description, à l'aide des outils disponibles dans le volet de gauche.

4. Cliquez sur une fiche API pour afficher la documentation de référence de l'API.
   La documentation de référence de l'API s'affiche.

Les utilisateurs du portail peuvent se familiariser avec les API et les essayer, ou télécharger le document utilisé pour afficher la documentation de référence de l'API. Consultez la page Publier des API pour en savoir plus sur l'affichage de la documentation de référence de l'API.

Partager la responsabilité d'une application à l'aide d'équipes de développeurs (version bêta)

Remarque : Vous devez être inscrit à la version bêta de la fonctionnalité d'équipes.

Les équipes de développeurs permettent aux utilisateurs du portail de partager la responsabilité d'une application avec d'autres utilisateurs du portail. Les sections suivantes expliquent comment créer et gérer des équipes de développeurs.

Point important : Les équipes de développeurs sont simplement appelées "équipes" dans le portail des développeurs.

À propos des rôles de l'équipe de développeurs

Le tableau suivant récapitule les rôles pouvant être attribués aux membres d'une équipe de développeurs :

Remarque : En tant que membre de l'équipe de développeurs, vous pouvez vous retirer de n'importe quelle équipe de développeurs, quel que soit votre rôle, sauf si vous êtes propriétaire de l'équipe de développeurs.

Rôle	Description
Administrateur d'applications	Droits de lecture seule sur les membres et les détails de l'équipe de développeurs. Droits de lecture et d'écriture sur les applications.
Propriétaire	Droits de lecture et d'écriture complets sur les membres et les détails de l'équipe de développeurs ainsi que sur les applications.
Lecteur	Droits de lecture seule sur les membres et les détails de l'équipe de développeurs ainsi que sur les applications.

Afficher la page "Teams" (Équipes)

La page "Teams" (Équipes) affiche les équipes de développeurs dont vous êtes membre.

Pour accéder à la page "Teams" (Équipes), procédez comme suit :

1. Connectez-vous au portail.
2. Sélectionnez Teams (Équipes) dans la liste déroulante des comptes utilisateur du portail.

La page "Teams" (Équipes) s'affiche. Vous pouvez alors effectuer les actions suivantes :

• Afficher les équipes de développeurs dont vous êtes membre, y compris le nom, le rôle, la liste des membres et la date de création de l'équipe
• Ajouter une équipe de développeurs
• Modifier les membres et les rôles d'une équipe de développeurs, vous retirer d'une équipe de développeurs ou supprimer une équipe en cliquant sur la ligne correspondante

Ajouter des équipes de développeurs

Remarque : Les utilisateurs du portail peuvent visualiser les équipes de développeurs dont ils sont membres sur la page Teams (Équipes). Dans la version bêta, aucune notification n'est envoyée lorsqu'un utilisateur du portail est ajouté à une équipe de développeurs.

Pour ajouter une équipe de développeurs, procédez comme suit :

1. Connectez-vous au portail.
2. Sélectionnez Teams (Équipes) dans la liste déroulante des comptes utilisateur du portail.
3. Cliquez sur + New Team (+ Nouvelle équipe).
4. Saisissez un nom et une description.

5. Pour ajouter un membre à l'équipe de développeurs, cliquez sur + Add another member (+ Ajouter un autre membre), saisissez l'adresse e-mail de l'utilisateur du portail, puis sélectionnez un rôle au sein de l'équipe de développeurs.

   Répétez l'opération pour ajouter d'autres membres.

   Remarque :

   • Vous êtes ajouté automatiquement en tant que propriétaire de l'équipe de développeurs.
   • Le nombre maximal d'équipes de développeurs dont un utilisateur peut être membre est de 16.

6. Pour supprimer un membre de l'équipe de développeurs, cliquez sur à côté du membre que vous souhaitez supprimer.

7. Cliquez sur Create (Créer).

Modifier les membres et les rôles d'une équipe de développeurs

Pour modifier les membres et les rôles d'une équipe de développeurs, procédez comme suit :

1. Connectez-vous au portail.
2. Sélectionnez Teams (Équipes) dans la liste déroulante des comptes utilisateur du portail.
3. Cliquez sur la ligne de l'équipe de développeurs que vous souhaitez modifier et dont vous êtes propriétaire.

4. Effectuez une ou plusieurs des étapes suivantes :

   • Modifiez le nom, la description et le contact principal.
   • Ajoutez ou supprimez des membres de l'équipe de développeurs.
   • Mettez à jour les rôles des membres de l'équipe de développeurs.
     Remarque :

     • Une équipe de développeurs doit compter au moins un propriétaire.
     • Le nombre maximal d'équipes de développeurs dont un utilisateur peut être membre est de 16.

5. Cliquez sur Enregistrer.

Se retirer d'une équipe de développeurs

Remarque : En tant que membre de l'équipe de développeurs, vous pouvez vous retirer de n'importe quelle équipe de développeurs, quel que soit votre rôle au sein de cette équipe, sauf si vous en êtes le propriétaire.

Pour vous retirer d'une équipe de développeurs, procédez comme suit :

1. Connectez-vous au portail.
2. Sélectionnez Teams (Équipes) dans la liste déroulante des comptes utilisateur du portail.
3. Cliquez sur la ligne correspondant à l'équipe de développeurs que vous voulez quitter.
4. Cliquez sur Leave Team (Quitter l'équipe).

Supprimer une équipe de développeurs

Remarque : Lorsque vous supprimez une équipe de développeurs, toutes les applications appartenant à cette équipe sont également supprimées.

Pour supprimer une équipe de développeurs, procédez comme suit :

1. Connectez-vous au portail.
2. Sélectionnez Teams (Équipes) dans la liste déroulante des comptes utilisateur du portail.
3. Cliquez sur la ligne de l'équipe de développeurs que vous souhaitez supprimer.
4. Cliquez sur .
5. Cliquez sur Confirm (Confirmer) pour confirmer la suppression.

Enregistrer des applications

Enregistrez des applications de développeur et des applications d'équipe de développeurs, comme décrit dans les sections suivantes.

Enregistrer des applications de développeur

Point important : Une fois que l'utilisateur du portail a enregistré une application de développeur, les informations du compte utilisateur sont synchronisées et mises à disposition sur Edge sur la page Developers (Développeurs). Consultez la section Emplacement de stockage des informations de compte de développeur d'applications.

Les utilisateurs du portail peuvent enregistrer des applications pour utiliser les API que vous avez publiées, comme suit :

1. Sélectionnez Applications dans la liste déroulante des comptes utilisateur.
2. Cliquez sur + New App (+ Nouvelle application) pour créer une application.
3. Dans la boîte de dialogue "Nouvelle application", saisissez un nom et une description pour l'application.

4. Dans la section "Catalogue d'API", sélectionnez une ou plusieurs API.

   Les API du catalogue sont classées en tant qu'API authentifiées, nécessitant une URL de rappel ou des API publiques. Pour créer une application, vous devez sélectionner au moins une API.

5. Si vous sélectionnez une API dans la section "API authentifiées", vous devez saisir une URL de rappel.

   Pour en savoir plus, consultez l'article À propos des URL de rappel.

6. Cliquez sur Create (Créer).

Enregistrer des applications d'équipe de développeurs

Remarque : Cette étape ne s'applique que si vous êtes inscrit à la version bêta de la fonctionnalité d'équipes. Dans la version bêta, vous ne pouvez pas transférer la propriété d'une application après sa création.

Les membres d'équipe de développeurs peuvent enregistrer des applications pour qu'une équipe de développeurs puisse utiliser les API que vous avez publiées, comme décrit ci-dessous.

Remarque : Une nouvelle entité d'équipe de développeurs n'est ajoutée à Edge qu'après qu'un membre a enregistré une application pour l'équipe. Consultez la section Emplacement de stockage des informations de l'équipe de développeurs (bêta).

Pour en savoir plus sur la façon dont :

• les utilisateurs du portail ajoutent et gèrent des équipes, comme décrit dans la section Partager la responsabilité d'une application à l'aide d'équipes de développeurs (version bêta) ;
• les fournisseurs d'API affichent et gèrent les équipes de développeurs, comme décrit sur la page Gérer les équipes de développeurs (version bêta).

Pour enregistrer des applications d'équipe de développeurs, procédez comme suit :

1. Sélectionnez Teams (Équipes) dans la liste déroulante des comptes utilisateur.
2. Cliquez sur la ligne de l'équipe de développeurs pour laquelle vous souhaitez enregistrer une application.
3. Cliquez sur + New App (+ Nouvelle application) pour créer une application.
4. Dans la boîte de dialogue "Nouvelle application", saisissez un nom et une description pour l'application.

5. Sélectionnez le propriétaire de l'application dans la liste déroulante Owner (Propriétaire).

   Par défaut, l'équipe de développeurs est propriétaire de l'application. Si vous le souhaitez, sélectionnez dans le menu déroulant une autre équipe de développeurs ou vous-même en tant que propriétaire.

   Remarque : Dans la version bêta, vous ne pouvez pas transférer la propriété d'une application après sa création.

6. Dans la section "Catalogue d'API", sélectionnez une ou plusieurs API.

   Les API du catalogue sont classées en tant qu'API authentifiées, nécessitant une URL de rappel ou des API publiques. Pour créer une application, vous devez sélectionner au moins une API.

7. Si vous sélectionnez une API dans la section "API authentifiées", vous devez saisir une URL de rappel.

   Pour en savoir plus, consultez l'article À propos des URL de rappel.

8. Cliquez sur Create (Créer).

Gérer les API dans une application

En tant que producteur d'API, vous publiez des API pour permettre aux utilisateurs du portail d'utiliser vos produits d'API.

Les utilisateurs du portail gèrent les API que leurs applications utilisent. Les API sont ajoutées à la page d'informations sur l'application. Pour certaines API, l'approbation n'est pas automatique. L'état En attente d'approbation indique une API pour laquelle l'accès a été demandé, mais pas encore accordé.

Remarque  Les API non publiées ne sont actuellement pas affichées. Ce problème sera résolu dans une prochaine version.

Si l'utilisateur du portail désactive l'accès à une API privée ou interne uniquement, cette API est supprimée de l'application et doit être rajoutée manuellement par l'administrateur du portail, comme décrit sur la page Contrôler l'accès aux API en enregistrant des applications.

Les utilisateurs du portail peuvent gérer les API dans une application à partir de votre portail, comme suit :

1. Sélectionnez Applications dans la liste déroulante des comptes utilisateur.
2. Cliquez sur l'application dans la liste.
3. Dans la section "API", cliquez sur ou pour activer ou désactiver l'accès, respectivement, à une API depuis l'application.
4. Pour une API authentifiée, ajoutez ou modifiez l'URL de rappel, si nécessaire.

Afficher la clé API et le code secret d'une application

Les utilisateurs du portail peuvent gérer la clé API d'une application à partir de votre portail, comme suit :

1. Sélectionnez Applications dans la liste déroulante des comptes utilisateur.
2. Cliquez sur l'application dans la liste.
3. Affichez les clés API dans la section Clés API.
4. Vérifiez que l'état de la clé API est "Actif".
   Si votre clé API nécessite une approbation et n'a pas encore été approuvée, l'état affiché sera En attente d'approbation.
5. Cliquez sur Afficher le secret pour afficher le secret.
6. Placez votre curseur sur la clé API ou le secret, puis cliquez sur pour les copier dans le presse-papiers.

Remarque : Si le compte utilisateur ou l'application ont été désactivés ou révoqués, la clé API ne sera valide que lorsque le compte utilisateur ou l'application seront activés ou approuvés de nouveau. Pour en savoir plus, consultez les sections Activer et désactiver un développeur et Approuver ou révoquer une application.

Faire pivoter la clé API d'une application

Un utilisateur du portail peut faire pivoter la clé API d'une application régulièrement, ou en réponse à une fuite ou une attaque potentielles. Lorsqu'un utilisateur du portail fait pivoter une clé API, une autre clé API est créée avec les mêmes droits d'API que la clé d'origine. La clé API d'origine reste active pendant la transition. Vous devez révoquer l'ancienne clé API pour empêcher que ses identifiants soient acceptés, comme décrit dans la section Révoquer une clé API pour une application.

Les utilisateurs du portail peuvent effectuer la rotation de la clé d'API d'une application à partir de votre portail, comme suit :

1. Sélectionnez Applications dans la liste déroulante des comptes utilisateur.
2. Cliquez sur l'application dans la liste.
3. Dans la section "Clés API", cliquez sur Ajouter une clé.
4. Cliquez sur Confirmer (Confirmer) dans la boîte de dialogue pour confirmer l'opération.
5. Vous pouvez éventuellement révoquer l'ancienne clé API, comme décrit ci-dessous.

Révoquer une clé API pour une application

Lorsqu'un utilisateur du portail effectue une rotation de clé API, comme décrit dans la section précédente, la clé API reste active pendant la transition. Pour empêcher que les identifiants d'une clé API soient acceptés, vous devez la révoquer.

Les utilisateurs du portail peuvent révoquer la clé API d'une application à partir de votre portail, comme suit :

1. Sélectionnez Applications dans la liste déroulante des comptes utilisateur.
2. Cliquez sur le nom de l'application.
3. Dans la section "Clés API", cliquez sur dans la colonne "Actions" associée à la clé API que vous souhaitez révoquer.

4. Cliquez sur Confirmer pour confirmer l'opération.

   L'état de la clé passe à "Révoqué".

Modifier les informations sur l'application

Les utilisateurs du portail peuvent modifier les détails de l'application comme suit :

1. Sélectionnez Applications dans la liste déroulante des comptes utilisateur.
2. Cliquez sur l'application dans la liste.
3. Modifiez les champs "Nom" ou "Description" dans l'onglet "Informations sur l'application".
4. Gérez les API dans une application, si nécessaire.
5. Cliquez sur Enregistrer.

Supprimer une application

Les utilisateurs du portail peuvent supprimer une application de votre portail, comme suit :

1. Sélectionnez Applications dans la liste déroulante des comptes utilisateur.
2. Cliquez sur l'application dans la liste.
3. Cliquez sur SUPPRIMER.
4. Cliquez sur Confirmer pour confirmer l'opération.

L'application est supprimée et retirée de la liste des applications.