Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
Apigee Edge offre un portail intégré et facile à utiliser pour documenter et gérer l'accès à vos API, et pour encourager votre communauté de développeurs d'applications.
Tous les utilisateurs d'Apigee Edge ont accès aux outils de développement de portail intégrés, ce qui leur permet de créer rapidement leur propre portail des développeurs, en offrant une alternative au développement de portail basé sur Drupal. Pour comparer les fonctionnalités, consultez la section Comparer les fonctionnalités du portail des développeurs.
Regardez cette courte vidéo pour découvrir comment créer et publier votre portail intégré.
Principaux avantages et fonctionnalités
Le portail intégré vous permet de bénéficier des avantages suivants :| Fonctionnalité | Avantages |
|---|---|
| Développement de contenu de portail | Développez rapidement et facilement le contenu de votre portail.
|
| Interface du portail | Personnalisez entièrement l'interface de votre portail en utilisant des feuilles de style SCSS et un branding personnalisé. |
| Documentation sur l'API | Générez automatiquement la documentation de référence de l'API en fonction de vos spécifications OpenAPI. |
| Enregistrement en libre-service | Fournissez aux développeurs un enregistrement en libre-service qui leur permet de créer des applications à l'aide de vos API. |
| Gestion des audiences | Contrôlez l'accès au contenu et aux API du portail. |
| Analyse | Configurez Google Analytics et le suivi des données analytiques personnalisé. |
| Personnalisations avancées | Effectuez des personnalisations avancées du portail, y compris :
|
Commencer à créer votre portail
Comment Apigee gère la sécurité dans le portail intégré ?
Le tableau suivant décrit la façon dont Apigee gère la sécurité grâce aux fonctionnalités intégrées du portail intégré.
| Caractéristique | Adresses |
|---|---|
| HTTPS et TLS (Transport Layer Security) requis | Applique la communication chiffrée. |
Inclut l'enregistrement du domaine apigee.io avec la liste des suffixes publics |
Interdit de définir des "supercookies" dans les sous-domaines de apigee.io. |
| Compatible avec la configuration de Content Security Policy (CSP). | Se protéger contre les script intersites (XSS) et d'autres attaques d'injection de code |
Nécessite :
|
Protégez-vous contre les attaques d'injection HTML, SQL ou backend. |
Inclut l'en-tête XSS x-content-type-options: nosniff |
Empêche les navigateurs de tenter de deviner les types MIME |
Inclut l'en-tête XSS x-frame-options: deny |
Empêche l'intégration du contenu du portail dans un iFrame |
Inclut l'en-tête XSS x-xss-protection: 1 |
Interdit le chargement des pages lorsqu'elles détectent des attaques de script intersites |
| Utilise des jetons CSRF | Protection contre la contrefaçon de requêtes intersites |
Utilisation :
|
Protections des données client |
Comment le portail intégré communique-t-il avec Edge ?
La majeure partie des informations utilisées par le portail des développeurs sont stockées sur Apigee Edge. Le portail agit en tant que client d'Edge. Si nécessaire, le portail des développeurs envoie une requête REST HTTP ou HTTPS afin de récupérer des informations depuis Edge ou d'envoyer des informations à Edge. Par exemple, lorsqu'un utilisateur du portail enregistre une nouvelle application sur le portail, celui-ci envoie une requête à Edge pour stocker des informations sur l'application.
Les sections suivantes fournissent plus de détails.
Où sont stockés l'enregistrement de l'application et les clés API
Lorsqu'un utilisateur du portail termine le processus d'enregistrement de l'application sur le portail intégré, le portail envoie des informations sur l'application à Apigee Edge, y compris le nom de l'application et les produits API associés à l'application. Si Edge enregistre correctement l'application, il renvoie une seule clé API au portail. L'utilisateur du portail utilise cette clé API pour accéder aux produits API associés à l'application.
Les informations sur les applications et les clés API ne sont stockées que dans Edge, et non sur le portail. Lorsqu'un utilisateur du portail utilise le portail pour afficher des informations sur une application, par exemple via la page "Mes applications", le portail envoie une requête à Edge avec la clé API pour accéder aux informations.
De même, lorsqu'un utilisateur du portail ajoute, supprime ou modifie une application, le portail envoie les modifications à Edge pour les stocker.
Étant donné que toutes les informations spécifiques aux applications et aux clés API sont stockées dans Edge, un administrateur Edge peut les modifier à l'aide de l'interface utilisateur Edge ou de l'API de gestion. Par exemple, un administrateur peut :
- ajouter, supprimer ou modifier une application de développement ;
- approuver ou révoquer une clé API pour une application de développeur.
Pour en savoir plus, consultez la page Enregistrer des applications et gérer des clés API.
Où les informations de compte de développeur d'applications sont-elles stockées ?
Les informations de compte de développeur sont stockées dans Edge, comme suit:
- En cas d'utilisation du fournisseur d'identité intégré, lorsqu'un utilisateur du portail crée un compte, les informations sont stockées dans le fournisseur d'identité et affichées sur la Page "Utilisateurs"
- En cas d'utilisation du fournisseur d'identité SAML, lorsqu'un utilisateur du portail se connecte au portail, un enregistrement fictif des informations est stocké dans le fournisseur d'identité. ets'affiche sur la page Utilisateurs.
- Lorsqu'un utilisateur du portail enregistre une application de développeur, les informations de compte de l'utilisateur sont synchronisées et mises à disposition sur Edge sur la page des développeurs.
Les informations de compte utilisateur suivantes sont stockées sur Edge:
- Prénom et nom
- Adresse e-mail
- Nom d'utilisateur
- État du compte sur le portail (actif ou inactif)
- Rôle sur le portail (utilisateur authentifié, administrateur, autre)
- Autorisations basées sur le rôle
- Équipes dont l'utilisateur du portail est membre (si vous êtes inscrit à la version bêta de la fonctionnalité d'équipe)
L'adresse e-mail est la clé primaire utilisée par Edge pour identifier le développeur et chaque adresse e-mail doit être unique. À partir de la clé primaire, Edge génère un ID de développeur unique pour chaque organisation à laquelle appartient le développeur.
Pour en savoir plus, consultez la page Enregistrer des développeurs d'applications.
Emplacement de stockage des informations de l'équipe de développeurs (bêta)
Lorsqu'une équipe de développeurs est créée sur le portail par un utilisateur du portail, les informations de celle-ci sont stockées sur Edge, y compris:
- Nom et description de l'équipe de développeurs
- Membres de l'équipe de développeurs et rôles
- Applications auxquelles l'équipe de développeurs est attribuée
- Audiences attribuées à l'équipe de développeurs
- Heure de création de l'équipe de développeurs
Une adresse e-mail unique générée automatiquement est générée pour l'équipe de développeurs. Elle sert de clé primaire utilisée par Edge pour identifier l'équipe de développeurs.
Pour en savoir plus, consultez les articles Partager la responsabilité d'une application avec les équipes de développeurs (bêta) et Gérer les équipes de développeurs.
À propos de l'exemple de portail
Lorsque vous créez un portail, un ensemble de pages de démarrage vous est fourni comme point de départ. Les pages de démarrage incluent des vidéos de démonstration qui vous aident à développer votre propre portail à mesure que vous remplacez le texte et les images par votre propre contenu. L'exemple de thème de portail utilise les composants de conception matérielle et les SCSS.
Vous trouverez ci-dessous la page d'accueil de l'exemple de portail.
Les pages de démarrage fournies avec l'exemple de portail incluent :
| Page | Description |
|---|---|
| Accueil | Page d'accueil du portail qui décrit les API présentées. Elle sert de page d'accueil par défaut pour votre portail (index.html). Montre l'utilisation de composants matériels angulaires, comme décrit dans la section Ajouter des composants matériels angulaires. |
| Guide de démarrage rapide | Ensemble d'étapes de démarrage rapide qui expliquent comment personnaliser le portail. Cliquez sur Démarrage rapide dans l'exemple de portail pour découvrir comment ajouter du contenu à la page Premiers pas. |
| Premiers pas | Exemple de page de contenu. Consultez la page Premiers pas de l'exemple de portail pour découvrir comment modifier cette page et l'ajouter à la barre de navigation supérieure. |
| API | Liste des API disponibles. Lorsque vous générez une documentation de référence interactive sur l'API, des liens vers le contenu sont ajoutés automatiquement à cette page. Remarque : Le contenu de cette page est généré automatiquement sur la base des API que vous publiez sur votre portail. Vous ne pouvez pas modifier directement le contenu de cette page ; il ne figure pas dans la liste des pages. Vous pouvez modifier le style de la page à l'aide de l'éditeur de thème du portail. |
| Mes applications | Liste des applications enregistrées pour un utilisateur autorisé. Consultez la section Interaction des utilisateurs du portail avec votre portail. Remarque : Le contenu de cette page est généré automatiquement en fonction des applications utilisateur enregistrées. Vous ne pouvez pas modifier directement le contenu de la page ; il ne figure pas dans la liste des pages. Vous pouvez modifier le style de la page à l'aide de l'éditeur de thème. |
| Se connecter | Page de connexion des utilisateurs enregistrés Les nouveaux utilisateurs peuvent s'inscrire sur cette page en cliquant sur Connexion. Consultez la section Interaction des utilisateurs du portail avec votre portail. Remarque : La page de connexion est automatiquement incluse dans votre portail. Vous pouvez personnaliser le logo sur la page de connexion et ajouter des champs d'inscription personnalisés à la page "Créer un compte". Vous ne pouvez pas modifier directement le contenu de la page ; il ne figure pas dans la liste des pages. |
| Conditions d'utilisation | Exemple de page des conditions d'utilisation |
Prise en charge des navigateurs
Les portails intégrés Apigee sont compatibles avec les mêmes versions de navigateur que Apigee Edge.