Créer votre portail intégré

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

Apigee Edge est un portail intégré facile à utiliser qui vous permet de documenter et de gérer l'accès à vos API, et de développer votre communauté de développeurs d'applications.

Tous les utilisateurs d'Apigee Edge ont accès aux outils de développement du portail intégré qui leur permettent de créer rapidement leur propre portail des développeurs, offrant ainsi 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 offre les principaux avantages et fonctionnalités suivants:
Caractéristique Avantages
Développement de contenu de portail Développez le contenu de votre portail rapidement et facilement.
  • Créez des pages à l'aide de l'éditeur de page simple à utiliser.
  • Rédigez du contenu avec Markdown et HTML.
  • Ajoutez des menus pour la navigation dans le 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 pour effectuer les opérations suivantes:
  • Personnalisez votre domaine.
  • Ajoutez des champs d'enregistrement personnalisés.
  • Étendez votre portail à l'aide de scripts.
  • Configurez votre e-mail.

Commencez à 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
Nécessite les protocoles HTTPS et TLS (Transport Layer Security) Applique une communication chiffrée
Inclut l'enregistrement de domaines apigee.io avec une liste de suffixes publics Interdiction de la définition des "supercookies" sur les sous-domaines de apigee.io
Il est compatible avec la configuration de Content Security Policy (CSP). Protège contre les scripts intersites (XSS) et les autres attaques par injection de code
Nécessite :
  • Nettoyage des données saisies dans un formulaire
  • Injection JavaScript sur l'ensemble du site limitée aux administrateurs
Protège contre les attaques par injection HTML, SQL ou backend
Inclut x-content-type-options: nosniff en-tête XSS Empêche les navigateurs de deviner les types MIME
Inclut x-frame-options: deny en-tête XSS Interdit l'intégration du contenu du portail dans un iFrame
Inclut x-xss-protection: 1 en-tête XSS Empêche le chargement des pages lorsqu'elles détectent des attaques de script intersites (XSS) reflétées
Utilise des jetons CSRF Protège contre la falsification de requêtes intersites
Exploitez : Protections des données client

Comment le portail intégré communique avec Edge

La majorité des informations utilisées par le portail des développeurs sont stockées sur Apigee Edge. Le portail agit comme un client pour Edge. Si nécessaire, le portail des développeurs envoie une requête REST HTTP ou HTTPS pour récupérer ou envoyer des informations à Edge. Par exemple, lorsqu'un utilisateur du portail enregistre une nouvelle application sur le portail, le portail 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 d'API associés à l'application. Si Edge enregistre l'application avec succès, Edge 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 sont stockées uniquement sur Edge ; elles ne sont pas stockées sur le portail. Lorsqu'un utilisateur du portail utilise le portail pour afficher des informations sur une application, via la page Mes applications par exemple, le portail envoie une requête à Edge avec la clé API pour accéder à ces informations.

De même, lorsqu'un utilisateur du portail ajoute, supprime ou modifie une application, le portail envoie les modifications à Edge pour qu'elles soient stockées.

Étant donné que toutes les informations sur les applications et les clés API sont stockées sur Edge, un administrateur Edge peut modifier les informations à 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 sur Edge, comme suit:

Les informations de compte d'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 de portail (utilisateur authentifié, administrateur, autre)
  • Autorisations basées sur les rôles
  • É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 chacune 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, ses informations 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 et 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 ajouter du contenu à la page Premiers pas.
Commencer Exemple de page de contenu. Consultez la page Premiers pas de l'exemple de portail pour savoir comment modifier cette page et l'ajouter au menu de navigation supérieur.
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 qu'Apigee Edge.