Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
En tant que fournisseur d'API, vous avez développé un ensemble d'API pour permettre l'accès à vos services de backend. L'étape suivante consiste à créer votre portail des développeurs pour permettre aux développeurs d'applications d'effectuer les opérations suivantes:
- Obtenir des informations sur vos données et vos offres de services
- Découvrir comment utiliser vos API en consultant la documentation complète, y compris un exemple de cas d'utilisation, des tutoriels et une documentation de référence.
- S'inscrire à l'aide d'un processus en libre-service afin de créer des applications utilisant vos API.
Présentation des solutions du portail des développeurs
Apigee est compatible avec plusieurs solutions de portail pour les développeurs, résumées dans le tableau suivant, d'une solution clé en main simple à une solution entièrement personnalisable et extensible. Lorsque vous choisissez une solution, vous devez trouver le bon équilibre entre vos besoins de personnalisation et le temps et les connaissances nécessaires pour implémenter votre portail.
Solution | Fonctionnalités | Hébergé par Apigee ? | Assistance (nécessite un abonnement sous licence) |
---|---|---|---|
Portail intégré Apigee | Développement simple d'un portail en libre-service. (Clients Apigee Edge Public Cloud uniquement) |
Oui | Assistance Apigee 24h/24, 7j/7 |
Portail Drupal 9 | Développement de portail en libre-service entièrement personnalisable à l'aide de projets Open Source Drupal 9. Intégration à Apigee à l'aide du module Apigee Edge | Non | Assistance Apigee 24 h/24, 7 j/7 pour les problèmes de dépannage |
Portail personnalisé | Développement de portail entièrement personnalisable à l'aide des API de la plate-forme Apigee. | Non | Assistance Apigee 24h/24, 7j/7 pour les API de la plate-forme Apigee uniquement |
Choisir la solution de portail des développeurs
Pour vous aider à choisir votre solution de portail des développeurs, tenez compte de l'arbre de décision ci-dessous et consultez la page Comparaison des fonctionnalités du portail des développeurs.
Si vous êtes un client Apigee Edge pour Public Cloud, envisagez de créer un portail intégré Apigee si vous prévoyez de prendre en charge des cas d'utilisation courants pour le développement de portail, tels que les flux d'enregistrement et de création d'applications standards, et si vous souhaitez apporter des modifications plus stylistiques que les modifications fonctionnelles.
Les portails basés sur Drupal sont actuellement la seule option proposée aux clients Apigee Edge pour le cloud privé et la monétisation.
Comparaison des fonctionnalités des portails de développeurs
Le tableau suivant compare les fonctionnalités du portail intégré d'Apigee et du portail de développeurs basé sur Drupal.
Caractéristique | Portail intégré | Drupal |
---|---|---|
Développement de contenu de portail à l'aide de Markdown | ||
Développement de contenu de portail à l'aide de code HTML | ||
Documentation de référence de l'API affichée à partir des spécifications OpenAPI | ||
Compatibilité de la spécification OpenAPI version 3 | ||
Envoyer des requêtes actives à partir de la documentation de référence de votre API | ||
Thème personnalisé | ||
Menus personnalisés | ||
Balises tierces, telles que Google Analytics | ||
Code JavaScript personnalisé | ||
Nom du domaine personnalisé | ||
HTTPS activé | ||
Conditions d'utilisation pour la création d'un compte | ||
Optimisation de l'affichage sur les appareils mobiles | ||
Intégration avec des scripts personnalisés et des tags de script | ||
Configuration SMTP | ||
Configuration du modèle d'e-mail | ||
CAPTCHA pour éviter le spam | ||
Rôles et autorisations pour les comptes de développeur/consommateur | ||
Connexion fédérée | ||
API de gestion de contenu | Utiliser Drupal | |
Monétisation | Bientôt disponible | |
Configuration de la recherche | * | |
Blog et forums | ** | |
Modèles de pages pour la création de contenu | ||
Analyse des applications sur le portail | ||
Gestion des événements basée sur des règles | ||
Extensible avec des modules complémentaires | ||
Flux d'enregistrement des applications personnalisées | ||
Flux d'enregistrement des développeurs personnalisés | ||
Journaux du portail | ||
Vérification des liens | ||
Compatibilité avec Microsoft Internet Explorer/Microsoft Edge | Microsoft Edge uniquement | |
Assistance Apigee | Voir le tableau ci-dessus | Voir le tableau ci-dessus |
Créer un portail intégré
Si vous êtes un client Apigee Edge pour Public Cloud, vous pouvez créer rapidement un portail de développeurs léger dans l'interface utilisateur Edge. Accédez à https://apigee.com/edge, connectez-vous, puis sélectionnez Publish > Portails (Publier > Portails) dans la barre de navigation latérale de l'interface utilisateur Edge. Pour en savoir plus, consultez la page Créer votre portail intégré.
La figure suivante présente la page de destination du portail intégré.
Créer un portail basé sur Drupal
À l'aide des outils de développement du portail Drupal, vous pouvez créer un portail des développeurs entièrement personnalisable. Drupal offre une large gamme de fonctionnalités, ainsi que toutes les fonctionnalités CMS de Drupal avec des modules Drupal supplémentaires développés par Apigee. La mise en œuvre d'un portail basé sur Drupal nécessite cependant plus de temps et d'efforts.
Apigee Edge est compatible avec les versions suivantes de Drupal:
Version | Description |
---|---|
Drupal 9 | Fournit un système de gestion de contenu (CMS) de niveau entreprise, Open Source et géré par le client. Étant donné que Drupal 9 est Open Source, vous pouvez étendre le framework de développement du portail Drupal 9 et y contribuer et tirer parti des connaissances de la communauté Drupal. Pour plus d'informations, consultez la section Créer votre portail à l'aide de Drupal 9. |
Créer un portail personnalisé à l'aide des API Apigee Edge
Créez votre propre portail entièrement personnalisé en exploitant les API Apigee Edge récapitulées dans le tableau suivant. Pour en savoir plus, consultez :
Catégorie | API Apigee | Description |
Analyses | Stats | Affichez les données analytiques de vos API. |
Clés API | Clés d'application: développeur | Gérez les clés API utilisées pour autoriser l'utilisation des API dans les applications. |
Produits d'API | Produits d'API | Gérez les produits d'API que vous publiez sur le portail des développeurs. |
Applications | Applications | Gérez les applications enregistrées par les développeurs pour utiliser vos API. |
Développeurs | Développeurs | Gérez les développeurs qui se sont enregistrés sur votre portail des développeurs. |
Monétisation | Monétisation | Monétisez vos API. |
Simplifiez l'intégration de votre client de portail à l'aide de la bibliothèque cliente Apigee Edge pour PHP. Le SDK facilite l'écriture de modules PHP utilisant les API Apigee décrites dans le tableau précédent. Pour en savoir plus sur la bibliothèque cliente des API Apigee pour PHP, consultez les sections suivantes :