Créer votre portail avec Drupal 7

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

Les portails de développeurs dotés de fonctionnalités de publication sur les réseaux sociaux sont de plus en plus utilisés pour communiquer avec la communauté des développeurs. Cela inclut la communication de contenu statique, tel que la documentation et les conditions d'utilisation des API, ainsi que le contenu dynamique fourni par la communauté, comme les blogs et les forums.

En tant que fournisseur d'API, vous avez besoin d'un moyen d'exposer vos API, d'informer les développeurs sur vos API, d'inscrire des développeurs et de permettre aux développeurs d'enregistrer des applications. Exposer vos API aux développeurs ne constitue qu'une partie de la création d'une communauté vraiment dynamique. Votre communauté de développeurs doit également pouvoir envoyer des commentaires, envoyer des demandes d'assistance et de fonctionnalités, et soumettre son propre contenu accessible aux autres développeurs.

Apigee Edge met à votre disposition un portail de services pour les développeurs qui vous permet de créer et de lancer votre propre site Web personnalisé afin de fournir tous ces services à votre communauté de développeurs. Chaque client Edge peut créer son propre portail de développeurs, dans le cloud ou sur site.

La vidéo suivante présente le portail de services pour les développeurs Apigee.

La figure suivante montre la page d'accueil du portail des développeurs par défaut:

Le portail des développeurs est essentiellement un système de gestion de contenu (CMS) basé sur le projet Open Source Drupal (http://www.drupal.org). Drupal fournit un ensemble de fonctionnalités essentielles sous la forme de modules qui vous permettent de créer et de gérer facilement le contenu de sites Web.

Le portail des développeurs prêt à l'emploi vous permet de créer de la documentation pour les API, est compatible avec les blogs et fournit des forums organisés en fils de discussion. Vous pouvez également personnaliser le portail des développeurs en fonction de vos besoins spécifiques. La personnalisation vous permet de modifier l'apparence du portail, ainsi que la façon dont les développeurs interagissent avec celui-ci.

Utilisez le menu Drupal pour effectuer la plupart des personnalisations. Si vous vous connectez au portail en tant qu'utilisateur disposant de droits d'administrateur, le menu Drupal s'affiche en haut de chaque page du portail:

L'administration contrôle le processus par lequel les développeurs demandent l'accès au portail, la manière dont ils enregistrent les applications qui accèdent à vos API, dont vous attribuez aux développeurs des rôles et des autorisations spécifiques en lien avec vos API, et à quel moment révoquer l'accès des développeurs aux API.

Vous pouvez également utiliser le portail des développeurs pour configurer et contrôler la monétisation. La monétisation permet aux développeurs d'accéder en libre-service à la facturation et aux rapports, au catalogue et aux forfaits, ainsi qu'à des paramètres spécifiques à la monétisation via le portail pour les développeurs.

Types d'utilisateurs du portail

L'image suivante illustre deux types d'utilisateurs du portail:

• Les développeurs constituent la communauté des utilisateurs qui créent des applications à l'aide de vos API. Les développeurs d'applications utilisent le portail pour en savoir plus sur vos API via SmartDocs, enregistrer un compte sur le portail, enregistrer des applications qui utilisent vos API, interagir avec la communauté de développeurs et afficher des informations statistiques sur leur utilisation des applications dans un tableau de bord.
• L'équipe API est le fournisseur d'API qui crée le contenu du portail, met ses API à la disposition des développeurs d'applications, fournit de la documentation sur les API, et fournit un mécanisme permettant aux développeurs d'enregistrer des applications et d'obtenir des clés API. L'équipe API effectue la configuration de base du portail des développeurs pour :
  • Configurer des requêtes automatiques ou manuelles de clés API
  • Gérer la documentation de l'API, les forums et les blogs, et éventuellement réviser toutes les modifications
  • Gérer les commentaires des utilisateurs et la modération des forums
  • Appliquez le contrôle des accès basé sur les rôles (RBAC) pour contrôler l'accès aux fonctionnalités du portail. Par exemple, un administrateur peut activer des commandes permettant à un utilisateur inscrit de créer des posts sur les forums ou d'utiliser des consoles de test.
  • Personnalisez les notifications par e-mail envoyées aux administrateurs et aux développeurs concernant la création et l'approbation d'utilisateurs.
  • Personnaliser les formulaires Web, comme les pages de contact

Un troisième type d'utilisateur du portail n'est pas illustré dans cette figure : le gestionnaire de produit d'API. Le chef de produit API est chargé de définir la façon dont l'équipe API crée le portail, y compris:

• Définition de la manière dont les API sont empaquetées dans les produits
• Définir les règles d'approbation des applications
• Définir les tarifs et les forfaits des produits d'API si la monétisation est activée sur le portail. Pour en savoir plus sur la monétisation, consultez Vue d'ensemble de la monétisation.

Personnaliser le portail des développeurs

En tant que fournisseur d'API, réfléchissez à la manière de personnaliser le portail des développeurs afin de l'adapter au mieux à vos API et de fournir à votre communauté de développeurs les informations nécessaires pour utiliser vos API. Voici quelques points à prendre en compte pour votre portail personnalisé:

• Accès facile à vos API
• Documentation, telle que les guides d'utilisation et les documents de référence
• Contenus fournis par la communauté, comme les blogs et les forums de discussion
• Exemple de code
• Un processus d'inscription facile grâce auquel les nouveaux développeurs, applications et API peuvent être approuvés rapidement
• Droits et identifiants gérés
• Contrôle des accès à plusieurs niveaux
• Une interface qui correspond à celle de votre organisation

Le portail est fourni avec une configuration de base prédéfinie. Par exemple, le portail est configuré par défaut pour permettre à tout le monde de s'inscrire en tant que développeur, mais un administrateur doit approuver chaque enregistrement pour que le développeur puisse se connecter au portail. Une fois l'enregistrement approuvé, le développeur peut enregistrer une application pour demander une clé API et utiliser le portail pour accéder aux ressources de l'API.

Les étapes du processus d'enregistrement par défaut sont les suivantes:

1. Le développeur s'inscrit sur le portail des développeurs. En réponse, le portail envoie un e-mail aux administrateurs pour qu'ils approuvent le compte.
2. Un administrateur approuve le compte, et un e-mail est envoyé au développeur pour l'informer qu'il peut désormais se connecter.
3. Le développeur enregistre une application et sélectionne les produits d'API qu'elle utilise. En réponse, le portail attribue une clé API unique à l'application.
4. Le développeur transmet la clé API lorsqu'il envoie des requêtes à votre API.

Cette expérience prête à l'emploi est hautement personnalisable. Par exemple, vous pouvez ignorer le schéma d'enregistrement et d'autorisation par défaut afin qu'un nouveau développeur soit automatiquement approuvé et connecté après l'enregistrement. Vous pouvez également demander au développeur d'accepter un ensemble de conditions d'utilisation avant de pouvoir se connecter pour la première fois.

Vous contrôlez entièrement le contenu disponible sur le portail des développeurs. Le portail des développeurs présente des exemples de contenu prêts à l'emploi, tels que de la documentation sur les API, des articles de blog et des discussions sur des forums. Vous pouvez fournir votre propre contenu et personnaliser l'apparence de chaque type de contenu.

Pour en savoir plus, consultez Personnaliser l'apparence.

Administrer le portail des développeurs

Les développeurs utilisent votre portail des développeurs pour accéder à votre API et l'utiliser. Les administrateurs effectuent des tâches de gestion des comptes, par exemple:

• Personnaliser le processus d'enregistrement des développeurs, y compris les champs d'enregistrement, le système Captcha intégré et l'approbation automatique ou manuelle
• Ajouter ou approuver des développeurs Par défaut, n'importe quel développeur peut s'inscrire via le portail des développeurs, mais il doit être approuvé par un administrateur via l'interface utilisateur du portail de développement. Les administrateurs peuvent également créer des développeurs directement sur le portail. Le portail envoie ensuite automatiquement un e-mail au développeur pour l'informer qu'un compte a été créé pour lui.
• Modifier un compte de développeur Par exemple, les administrateurs peuvent faire passer l'état du compte de l'utilisateur de "Actif" à "Bloqué", ou modifier les informations du profil du développeur, telles que le nom de l'entreprise.
• Supprimer un développeur Les administrateurs peuvent désactiver ou supprimer un compte de développeur.
• Attribution de rôles et d'autorisations: les administrateurs peuvent attribuer un rôle spécifique à un compte de développeur. Un rôle est associé à différentes autorisations, telles que l'autorisation de créer des livres ou d'autres contenus. Vous pouvez également modifier les autorisations associées à un rôle ou en créer d'autres.

Pour en savoir plus, consultez Ajouter et gérer des comptes utilisateur.

Résumé des fonctionnalités du portail des développeurs

Le tableau suivant contient un résumé des fonctionnalités du portail des développeurs:

Caractéristique	Détails
Prise en charge des navigateurs	Consultez la section Logiciels et versions compatibles.
Inscription d'utilisateurs	Approbation manuelle ou automatique des nouveaux comptes de développeur Intégration d'OpenID Compatibilité de l'authentification unique (SSO) avec Twitter, Google et GitHub CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart) Champs personnalisés
Gestion des utilisateurs	Créer et modifier des utilisateurs Attribuer des rôles
Apparence du portail	Personnaliser avec des modules CSS, images et Drupal
Gestion de contenu et de la communauté	Basé sur des solutions Open Source (Drupal) Création de contenu basée sur des modèles Types de contenus prêts à l'emploi pour la documentation, les blogs, le forum et les questions fréquentes sur les API Liens automatiques pour Del.icio.us, Digg et Twitter Contrôle de révision du contenu Tags, mots clés et archives pour les blogs Intégration dans Google Analytics Critères de popularité personnalisables pour les contenus Modération de messages et de commentaires sur le forum par l'administrateur Accès différent en fonction des rôles personnalisés, des utilisateurs connectés et des utilisateurs anonymes
Autorisations	Règles d'accès basées sur les rôles
Gestion des clés API	Enregistrement intégré des applications Possibilité d'approuver automatiquement ou manuellement les clés API Les administrateurs peuvent révoquer des clés.
E-mail	Indiquez votre serveur SMTP Configurer le moment où le portail envoie un e-mail aux développeurs Contrôler le contenu et le format des e-mails générés par le portail
Blogs	Créer, modifier et publier des articles de blog Autorisations basées sur les rôles pour limiter la création de blogs à des types d'utilisateurs spécifiques
Forums	Créer des forums pour les développeurs organisés en fils de discussion Créez d'autres catégories de forum si nécessaire. Modération basée sur les rôles
Documentation	Documentation de vos API Questions fréquentes Exemples Tutoriels
Menus	Contrôler l'apparence et le contenu du menu
Rechercher	Recherche Apache Solar intégrée Rechercher des contenus spécifiques Par exemple, des forums ou des blogs Contrôler l'indexation Google
Vérification des liens	Vérifiez que les pages ne comportent pas de liens non fonctionnels. Contrôler la liste de contrôle des liens