Interaction des utilisateurs avec votre portail

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

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 la manière dont les utilisateurs du portail se connectent au portail intégré à l'aide de leurs identifiants utilisateur (fournisseur d'identité intégré) ou à l'aide du protocole 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 utilisateur (fournisseur d'identité intégré)

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.

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

1. Accédez au portail.

2. Cliquez sur Sign In (Se connecter).

   La page de connexion s'affiche.

3. Cliquez sur Créer un compte.

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

   

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 Créer un compte.

7. 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é.

8. Dans les 10 minutes, cliquez sur le lien dans l'e-mail de confirmation pour terminer le processus d'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.

9. 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).

Les utilisateurs du portail se connectent comme suit :

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

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 (Se connecter).
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 de réinitialisation du mot de passe est envoyé à cette adresse e-mail.

6. Cliquez sur le lien 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 (bêta)

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 (Se connecter).

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.

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

Les utilisateurs du portail peuvent consulter la documentation de référence de l'API que vous avez publiée sur votre portail, 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. Filtrez la liste des API par catégorie, titre ou description, si vous le souhaitez, à l'aide des outils du 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 Publier vos API pour en savoir plus sur le rendu de la documentation de référence de l'API.

Partager la responsabilité d'une application avec les équipes de développeurs (bêta)

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.

À 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 :

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 "É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

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.

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

7. Cliquez sur Créer.

Modifier les membres et les rôles de l'é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.

5. Cliquez sur Enregistrer.

Vous retirer d'une équipe de développeurs

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

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éveloppement

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. Sélectionnez le propriétaire de l'application dans la liste déroulante Owner (Propriétaire).

   Par défaut, vous êtes le propriétaire de l'application. Si vous le souhaitez, sélectionnez une équipe de développeurs dans le menu déroulant afin de partager la responsabilité de l'application avec les autres membres de l'équipe. Consultez Partager la responsabilité d'une application avec les équipes de développeurs (version bêta).

5. 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.

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

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

7. Cliquez sur Créer.

Enregistrer les applications d'une équipe de développeurs

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.

Pour en savoir plus sur la façon dont :

• Les utilisateurs du portail ajoutent et gèrent des équipes, comme indiqué dans Partager la responsabilité d'une application avec les équipes de développeurs (version bêta).
• Les fournisseurs d'API affichent et gèrent les équipes de développeurs, comme indiqué dans Gérer les équipes de développeurs.

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.

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 À propos des URL de rappel.

8. Cliquez sur 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é.

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 qu'elle n'a pas encore été approuvée, l'état indique Pending Approval (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.

Effectuer une rotation de la clé API pour 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 la clé API d'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 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 la clé API d'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.