Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
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 de portail des développeurs
Apigee est compatible avec plusieurs solutions de portail des développeurs, résumées dans le tableau suivant, allant de la solution clé en main simple à une personnalisation complète et extensible. Lorsque vous choisissez une solution, vous devez équilibrer vos exigences de personnalisation en fonction du temps et des connaissances nécessaires pour mettre en œuvre votre portail.
Solution | Fonctionnalités | Hébergé par Apigee ? | Assistance (nécessite un abonnement sous licence). |
---|---|---|---|
Portail intégré Apigee | Développement simple pour un portail en libre-service. (clients du cloud public Apigee Edge uniquement) |
Oui | Assistance 24h/24, 7j/7 Apigee |
Portail Drupal 10 | Développement d'un portail en libre-service entièrement personnalisable à l'aide de projets Open Source Drupal 10. 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 à faire soi-même à 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 client Apigee Edge pour le cloud public, envisagez de créer un portail intégré Apigee si vous envisagez d'accepter des cas d'utilisation courants pour le développement d'un portail, tels que des flux d'enregistrement et de création d'application standards, et des modifications portant plus sur le style que les fonctionnalités.
Pour le moment, seuls les clients de monétisation et d'Apigee Edge pour Private Cloud peuvent bénéficier d'un portail Drupal.
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.
Fonctionnalité | Portail intégré | Drupal |
---|---|---|
Développement de contenu de portail à l'aide de Markdown | ||
Développement de contenu de portail avec 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 demandes en direct à partir de votre référence d'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 et des balises de script personnalisés | ||
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 client Apigee Edge pour le cloud public, vous pouvez créer rapidement un portail des développeurs léger dans l'UI Edge. Accédez à la page https://apigee.com/edge, connectez-vous et sélectionnez 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 Drupal suivantes:
Version | Description |
---|---|
Drupal 10 | Fournit un système de gestion de contenu (CMS) Open Source fiable, géré par le client et de niveau entreprise. Étant donné que Drupal 10 est Open Source, vous pouvez étendre le framework de développement du portail Drupal 10 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 10. |
Créer un portail personnalisé à l'aide des API Apigee Edge
Créez votre propre portail entièrement personnalisé en tirant parti des API Apigee Edge résumées dans le tableau suivant. Pour en savoir plus, consultez les pages suivantes :
Catégorie | API Apigee | Description |
Analytics | 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 du client de votre 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 :