Créer votre portail avec Drupal 7

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Les portails pour développeurs qui fournissent des fonctionnalités de publication sur les réseaux sociaux sont de plus en plus utilisés pour communiquer avec la communauté de développeurs. Ces échanges comprennent également la communication de contenus statiques, tels que la documentation sur l'API et les conditions d'utilisation, de contenus dynamiques envoyés par la communauté, comme les blogs et les forums.

En tant que fournisseur d'API, vous devez disposer d'un moyen d'exposer vos API, de les présenter aux développeurs, de les inscrire et de leur permettre d'enregistrer des applications. Exposer vos API aux développeurs n'est qu'une partie de la création d'une communauté vraiment dynamique. Vous devez également fournir à votre communauté de développeurs un moyen de donner leur avis, de demander de l'aide et de nouvelles fonctionnalités, et d'envoyer leur propre contenu accessible aux autres développeurs.

Apigee Edge vous fournit un portail de services pour les développeurs que vous pouvez utiliser pour créer et 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 des développeurs, que ce soit dans le cloud ou sur site.

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

La figure suivante montre la page d'accueil du portail pour les 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 de base sous la forme de modules qui vous permettent de créer facilement du contenu pour des sites Web et de les gérer.

Le portail des développeurs prêt à l'emploi vous permet de créer de la documentation pour les API. En outre, il est compatible avec les blogs et fournit des forums thématiques. Vous pouvez également personnaliser le portail du développeur pour répondre à vos besoins spécifiques. La personnalisation vous permet de modifier l'apparence du portail et la façon dont les développeurs interagissent avec celui-ci.

Vous 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, la manière dont vous leur attribuez des rôles et des autorisations spécifiques liés à vos API, et le moment où vous devez révoquer leur accès 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 plans, ainsi qu'aux paramètres spécifiques à la monétisation via le portail des développeurs.

Types d'utilisateurs du portail

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

• Les développeurs constituent la communauté d'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, pour créer un compte sur le portail, pour enregistrer les applications qui utilisent vos API, pour interagir avec la communauté des développeurs et pour afficher des informations statistiques sur l'utilisation de leur application 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 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 chargée des API effectue une configuration de base du portail des développeurs pour :
  • Configurer des requêtes automatiques ou manuelles pour les clés API
  • Gérer la documentation, les forums et les blogs de l'API, 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 pour autoriser un utilisateur enregistré à créer des posts sur un forum ou à utiliser des consoles de test.
  • Personnaliser les notifications par e-mail envoyées aux administrateurs et aux développeurs pour la création et l'approbation d'utilisateurs
  • Personnaliser des formulaires Web tels que les pages "Contactez-nous"

Un troisième type d'utilisateur du portail, le gestionnaire de produits d'API, n'est pas représenté dans cette figure. Le responsable produit de l'API est chargé de définir la manière dont l'équipe API crée le portail, y compris:

• Définir la façon dont les API sont empaquetées dans des produits
• Définir les règles d'approbation des applications
• Si la monétisation est activée sur le portail, définissez les tarifs et les plans de facturation pour les produits d'API. Pour en savoir plus sur la monétisation, consultez la section Présentation 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 pour qu'il s'adapte au mieux à vos API et fournissez les informations nécessaires à votre communauté de développeurs pour qu'ils puissent utiliser vos API. Voici quelques points à prendre en compte pour votre portail personnalisé:

• Accès facile à vos API
• Documentation, comme des guides d'utilisation et des documents de référence
• Contenus envoyés par la communauté, comme des blogs et des forums de discussion
• Exemple de code
• Un processus d'inscription simple permettant d'approuver rapidement de nouveaux développeurs, applications et API
• Droits et identifiants gérés
• Contrôle des accès par niveau
• Un style qui correspond à votre organisation

Le portail est fourni avec une configuration de base prédéfinie. Par exemple, le portail est configuré pour permettre à n'importe qui de s'inscrire en tant que développeur, mais un administrateur doit approuver chaque inscription avant 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.

Voici les étapes du processus d'enregistrement par défaut:

1. Le développeur s'inscrit via 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 utilisés par l'application. 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 remplacer le schéma d'enregistrement et d'autorisation par défaut afin qu'un nouveau développeur soit automatiquement approuvé et connecté après son enregistrement. Vous pouvez également exiger que le développeur accepte un ensemble de conditions d'utilisation avant de pouvoir se connecter pour la première fois.

Vous avez également le contrôle total sur le contenu disponible sur le portail des développeurs. Le portail des développeurs présente des exemples de contenu tels que la documentation de l'API, des articles de blog et des discussions sur des forums. Vous pouvez fournir vos propres contenus 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 de compte, par exemple:

• Personnalisation du processus d'enregistrement des développeurs, y compris des champs d'enregistrement, du Captcha intégré et de l'approbation automatique ou manuelle
• Ajouter ou approuver des développeurs Par défaut, tout développeur peut s'inscrire via le portail des développeurs, mais doit être approuvé par un administrateur via l'interface utilisateur du portail des développeurs. 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.
• Modification du compte d'un développeur Par exemple, les administrateurs peuvent faire passer l'état du compte de l'utilisateur d'Actif à Bloqué ou modifier les informations de profil du développeur, comme le nom de l'entreprise.
• Supprimer un développeur Les administrateurs peuvent désactiver ou supprimer le compte d'un développeur.
• Attribuer des rôles et des autorisations: les administrateurs peuvent attribuer un rôle spécifique à un compte de développeur. Un rôle est associé à diverses 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 créer des rôles.

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 récapitule les fonctionnalités du portail de développeurs:

Fonctionnalité	Détails
Prise en charge des navigateurs	Consultez la section Logiciels compatibles et versions compatibles.
Inscription d'utilisateurs	Approbation manuelle ou automatique des nouveaux comptes de développeur Intégration OpenID Prise en charge 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 à l'aide de CSS, d'images et de modules Drupal
Gestion des contenus et de la communauté	Basé sur Open Source (Drupal) Création de contenus basés sur des modèles Types de contenus disponibles immédiatement pour la documentation de l'API, les blogs, les forums et les questions fréquentes Liens automatiques pour Del.icio.us, Digg et Twitter Contrôle des versions du contenu Tags, mots clés et archives pour les blogs Intégration à Google Analytics Critères de popularité personnalisables pour les contenus Posts et commentaires sur le forum modérés par un 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 de l'application intégré Prise en charge de l'approbation automatique ou manuelle des clés API Les administrateurs peuvent révoquer des clés
E-mail	Indiquer votre serveur SMTP Configurer le moment où le portail envoie des e-mails 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 avec des fils de discussion Créer des catégories de forum supplémentaires 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 Solr intégrée Recherchez un contenu spécifique. (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 vérification des liens