Configurer l'enregistrement de l'application

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

Les développeurs utilisent la page "Mes applications" du portail des services pour les développeurs pour enregistrer des applications. Les développeurs peuvent accéder à la page "Mes applications" à partir du menu principal du portail:

Pour enregistrer une nouvelle application, le développeur sélectionne le bouton "Ajouter une nouvelle application" sur la page "Mes applications".

Le portail affiche ensuite le formulaire d'enregistrement de l'application par défaut:

Par défaut, le développeur n'a qu'à spécifier le nom de l'application, l'URL de rappel et la liste des produits d'API à ajouter à l'application.

En tant que fournisseur d'API, vous contrôlez totalement le processus d'enregistrement des applications. Par exemple, vous pouvez configurer:

• Liste des produits d'API disponibles sur le portail
• Existence ou non d'un produit API par défaut
• Si l'URL de rappel est requise
• Indique si la clé API est approuvée manuellement ou automatiquement pour un produit d'API.
• Si d'autres informations sont requises sur la page "Ajouter une application" pour enregistrer l'application

Cet article explique comment configurer le processus d'enregistrement des applications pour votre portail. Toutefois, cet article ne décrit pas comment créer des produits d'API. Pour en savoir plus, consultez les articles suivants:

• Créer des produits API
• Utiliser l'API de gestion en périphérie pour publier des API

Vous pouvez configurer le portail de manière à interdire aux développeurs de créer, supprimer ou modifier des applications en fonction du rôle attribué aux développeurs. Par exemple, vous pouvez configurer le portail pour créer une seule application par défaut pour tous les développeurs lorsque le développeur s'enregistre. Ensuite, vous n'autorisez que certains développeurs à ajouter de nouvelles applications, éventuellement en fonction d'une structure tarifaire ou d'autres caractéristiques du développeur. Utilisez des rôles et des autorisations pour contrôler quels développeurs peuvent créer, supprimer et modifier des applications. Pour en savoir plus, consultez la section Ajouter et gérer des comptes utilisateur.

Spécifier les produits d'API disponibles sur le portail

Il existe deux manières de spécifier les produits d'API disponibles lorsqu'un développeur accède au portail:

• Spécifier le niveau d'accès lors de la création d'un produit API
• Restreindre l'accès à un produit d'API en fonction des rôles

Spécifier le niveau d'accès lors de la création d'un produit API

Lorsque vous créez un produit API, vous spécifiez son niveau d'accès, comme indiqué ci-dessous:

Pour en savoir plus sur l'impact du niveau d'accès sur la disponibilité du produit d'API dans le portail des développeurs Drupal 7, consultez la section Niveau d'accès.

Restreindre l'accès à un produit d'API en fonction des rôles

En activant le module Drupal d'accès aux rôles de produit d'API, vous pouvez spécifier les rôles qui peuvent accéder à chaque produit d'API.

Pour restreindre l'accès à un produit d'API en fonction des rôles de développeur:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Examinez les rôles et les attributions des utilisateurs du portail de développement :
   • Sélectionnez Personnes > Autorisations > Rôles dans le menu d'administration de Drupal, puis ajoutez ou modifiez les rôles et autorisations de développeur, si nécessaire.
   • Sélectionnez People (Contacts) dans le menu d'administration de Drupal, puis modifiez les attributions d'utilisateurs et de rôles, si nécessaire.
3. Sélectionnez Configuration > Portail de développement > Accès aux rôles des produits d'API dans le menu d'administration de Drupal.
4. Sélectionnez les rôles auxquels vous souhaitez donner accès à chaque produit d'API.
5. Cliquez sur Enregistrer la configuration.

Configurer la manière dont un développeur associe les produits d'une API à une application

Pour enregistrer une nouvelle application, un développeur sélectionne le bouton "Ajouter une application" sur la page "Mes applications" pour ouvrir le formulaire "Ajouter une application" :

Selon la configuration du portail, le développeur peut sélectionner un ou plusieurs produits d'API à associer à l'application au moment de l'enregistrement. Vous pouvez également spécifier un produit par défaut attribué à toutes les applications.

Les options de configuration suivantes sont disponibles sur le portail pour contrôler la sélection des produits d'API lors de l'enregistrement d'une application:

• N'associez aucune application à un produit d'API.
• Associez toutes les applications à un ou plusieurs produits d'API par défaut (configurés ci-dessous). Les développeurs ne peuvent ajouter aucun autre produit d'API à l'application.
• Autoriser la sélection d'un seul produit API, mais ce n'est pas obligatoire.
• Exiger la sélection d'un seul produit API.
• Autoriser la sélection de plusieurs produits API, mais n'en exiger aucun.
• Autoriser la sélection de plusieurs produits d'API et en exiger au moins un.

Vous pouvez également contrôler l'élément HTML qui apparaît sur le formulaire utilisé par le développeur pour sélectionner le produit d'API. Les options sont les suivantes :

• Listes déroulantes
• Cases à cocher ou cases d'option Les cases à cocher s'affichent lorsque le développeur peut sélectionner plusieurs produits d'API et les cases d'option s'affichent lorsqu'il ne peut sélectionner qu'un seul produit d'API.

Pour définir l'option de sélection des produits API:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Sélectionnez Configuration > Dev Portal Settings > Application Settings (Configuration > Paramètres du portail de développement > Paramètres de l'application) dans le menu d'administration de Drupal.
3. Sur la page "Paramètres des applications", développez la zone Paramètres des produits d'API.
4. Sous Gestion des produits d'API, sélectionnez l'option qui contrôle la sélection des produits d'API.
5. Si vous spécifiez l'option "Associer toutes les applications à un ou plusieurs produits d'API par défaut (configurés ci-dessous)", définissez un produit par défaut sous Produit d'API par défaut.
6. Sous Widget de produit d'API, sélectionnez l'élément HTML utilisé par les développeurs pour sélectionner les produits d'API.
7. Enregistrez la configuration.

Configurer la gestion des URL de rappel

Si un proxy d'API de votre produit d'API utilise l'authentification OAuth à trois acteurs (type d'attribution de code d'autorisation), les développeurs doivent spécifier une URL de rappel lorsqu'ils enregistrent leurs applications. L'URL de rappel spécifie généralement l'URL d'une application destinée à recevoir un code d'autorisation au nom de l'application cliente. De plus, cette chaîne d'URL est utilisée pour la validation. Le client doit envoyer cette URL à Apigee Edge lors de la demande de codes d'autorisation et de jetons d'accès, et le paramètre redirect_uri doit correspondre à celui qui est enregistré. Pour en savoir plus, consultez la section Implémenter le type d'attribution de code d'autorisation.

Pour contrôler l'URL de rappel pour la sélection de produits API:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Sélectionnez Configuration > Dev Portal Settings > Application Attributes (Configuration > Paramètres du portail de développement > Attributs de l'application) dans le menu d'administration de Drupal.
3. Sur la page "Paramètres de l'application", développez la zone Paramètres de l'URL de rappel.
4. Sous Gestion des URL de rappel, sélectionnez l'une des options suivantes.
   • Une URL de rappel est requise pour toutes les applications de développement.
   • L'URL de rappel est facultative pour toutes les applications pour développeurs.
   • L'URL de rappel n'est ni requise, ni affichée.
5. Enregistrez la configuration.

Afficher les données analytiques pour l'utilisation des applications

Le portail peut afficher des informations analytiques sur l'utilisation des applications. Si l'affichage des données analytiques est activé, les développeurs d'applications peuvent les consulter sur la page "Mes applications" pour chaque application. Par exemple, un développeur peut afficher les données analytiques suivantes pour une application:

• Débit
• Temps de réponse maximal
• Temps de réponse minimal
• Nombre de messages
• Nombre d'erreurs

Pour activer Analytics sur le portail:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Sélectionnez Configuration > Dev Portal > Application Settings (Configuration > Portail de développement > Paramètres de l'application) dans le menu d'administration de Drupal.
3. Sur la page "Paramètres des applications", développez la zone Paramètres de performances des applications.
4. Cochez la case Afficher l'onglet "Solution d'analyse d'applications pour les développeurs".
5. Sélectionnez Test ou Production pour l'environnement dans lequel interroger les données d'analyse. Pour un portail accessible au public, vous sélectionnez généralement Production.
6. Enregistrez la configuration.

Pour afficher les données analytiques sur le portail pour une application:

1. Sélectionnez le nom de l'application sur la page "Mes applications".
2. Sélectionnez le lien Analytics correspondant à l'application.
3. Sélectionnez le type d'analyse à afficher et la plage de dates:
4. Les informations sélectionnées s'affichent:
   

Approuver ou révoquer manuellement une clé API pour un produit d'API

Lorsqu'un développeur ajoute un produit d'API à une application, puis enregistre l'application, le portail renvoie au développeur la clé API de cette application. Le développeur utilise ensuite cette clé API pour accéder aux proxys d'API regroupés par le produit d'API associé à l'application.

Vous contrôlez le processus d'approbation des clés pour chaque produit API lorsque vous créez le produit API:

Le processus d'approbation peut être:

• Automatique : une clé API approuvée est renvoyée par le portail pour le produit d'API lorsque le développeur enregistre l'application. Vous pouvez révoquer ultérieurement une clé approuvée automatiquement.
• Manuel : une clé API est renvoyée par le portail lorsque le développeur enregistre l'application, mais la clé n'est activée pour aucun produit d'API qui utilise l'approbation manuelle de la clé. Un administrateur doit approuver manuellement la clé API, dans l'interface utilisateur ou dans l'API de gestion Edge, avant qu'elle puisse être utilisée par le développeur pour accéder au produit d'API. Vous pouvez révoquer ultérieurement une clé approuvée manuellement.

Pour plus d'informations, consultez la page Créer des produits d'API.

Si votre portail permet à un développeur d'ajouter plusieurs produits d'API à une application, il peut ajouter certains produits avec l'approbation automatique des clés et d'autres avec l'approbation manuelle. Le développeur peut immédiatement utiliser la clé API renvoyée pour tous les produits d'API approuvés automatiquement en attendant l'approbation finale des produits nécessitant une approbation manuelle.

Pour afficher la liste des produits d'API d'une application et l'état de l'approbation de la clé pour le produit d'API, le développeur sélectionne le nom de l'application sur la page "Mes applications", puis sélectionne le lien "Produits" :

Dans cet exemple, le produit de l'API Premium Weather utilise l'approbation manuelle et attend qu'un administrateur approuve la clé. Le produit d'API sans frais utilise l'approbation automatique, et l'utilisation de la clé pour y accéder a été approuvée.

Pour approuver ou révoquer manuellement une clé:

1. Connectez-vous à l'interface utilisateur de gestion Edge en tant qu'utilisateur disposant des droits d'administration pour votre organisation.
2. Sélectionnez API Platform (Plate-forme d'API) dans la boîte déroulante en haut à droite.
3. Sélectionnez Publish > Developer apps (Publier > Applications de développement) pour ouvrir la liste des applications de développement.
4. Sélectionnez le bouton Pending (En attente) pour afficher la liste des applications avec des demandes de clés en attente:
   

   

5. Sélectionnez le nom de l'application que vous souhaitez approuver.
6. Sur la page d'informations de l'application, sélectionnez le bouton Edit (Modifier) en haut à droite.
7. Dans la liste des produits d'API pour l'application, sous Actions :
   • Pour approuver la clé, sélectionnez le bouton Approuver pour chaque produit d'API nécessitant une approbation manuelle.
     

     

   • Pour révoquer une clé approuvée, sélectionnez le bouton Révoquer sous "Actions" pour un produit d'API afin de révoquer l'accès.
     

     

8. Enregistrez l'application. La clé API est maintenant approuvée.

Contrôler la mise en cache des produits d'API et des applications

Les informations sur les produits d'API et les applications de développement sont stockées à distance à partir du portail sur Apigee Edge. Cela signifie que les modifications apportées aux produits et aux applications d'API peuvent être effectuées à partir de l'interface utilisateur ou de l'API Edge, sans passer par le portail. Par exemple, lorsqu'un administrateur backend ajoute un produit d'API, le portail n'est pas immédiatement mis à jour avec cette information.

Pour vous assurer que le portail reste synchronisé avec le backend Edge, vous pouvez déclencher manuellement une mise à jour du cache du portail et/ou mettre à jour les caches automatiquement lorsque la tâche Cron du portail est exécutée. Par exemple, si vous configurez la tâche Cron pour qu'elle s'exécute fréquemment, par exemple toutes les 5 ou 10 minutes, vous ne souhaitez peut-être pas avoir à gérer les mises à jour fréquentes des produits d'API et des applications de développement. Dans ce cas, vous pouvez déclencher manuellement la mise à jour du cache. Toutefois, si la tâche Cron s'exécute toutes les heures ou toutes les deux heures, le temps nécessaire pour mettre à jour les caches risque de ne pas avoir beaucoup d'impact.

Par défaut, le portail est configuré pour recompiler les caches du produit d'API et des applications de développement à chaque exécution d'une tâche Cron.

Pour indiquer si vous souhaitez recompiler le cache du produit d'API et de l'application de développement à chaque exécution de Cron:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Dans le menu Drupal, sélectionnez Configuration > Dev Portal Settings > Application Settings (Configuration > Paramètres du portail de développement > Paramètres de l'application).
3. Cochez ou décochez l'option Recompiler les caches du produit d'API et de l'application de développeur à chaque exécution de Cron.
4. Enregistrez vos paramètres.

Pour mettre à jour les caches manuellement:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Dans le menu Drupal, sélectionnez l'icône d'accueil > Vider tous les caches.

Personnaliser les champs de formulaire utilisés pour enregistrer une application

Lorsque le développeur enregistre une application, le portail affiche le formulaire par défaut:

En tant que fournisseur d'API, vous pouvez modifier ce formulaire pour inviter le développeur à fournir des informations supplémentaires telles que le numéro client, la plate-forme cible de l'application ou d'autres informations. Le portail vous permet d'ajouter des champs à ce formulaire. Ces champs peuvent être:

• Obligatoire ou facultatif
• Affichage par différents éléments HTML, tels que des zones de texte, des cases d'option, des cases à cocher, etc.
• Peut être configuré pour apparaître n'importe où sur le formulaire entre le champ "Callback URL" (URL de rappel) et le champ "Product" (Produit)

Par exemple, le formulaire suivant affiche un champ obligatoire pour le numéro client et un champ facultatif pour la plate-forme cible:

Lorsque vous ajoutez de nouveaux champs au formulaire, les valeurs des champs sont automatiquement téléchargées dans Edge, avec tous les autres champs, lorsque le développeur envoie le formulaire. Cela signifie que vous pouvez afficher ou modifier ces champs dans Edge, ou utiliser l'API de gestion Edge pour accéder à ces champs à partir d'un script.

Par exemple, affichez les nouveaux champs de formulaire dans l'interface utilisateur de gestion Edge en accédant à Publier > Applications de développement, puis en sélectionnant le nom de l'application. Les valeurs du nouveau champ apparaissent sous la zone "Attributs personnalisés" de la page, avec un nom qui correspond au nom interne du champ:

Les valeurs des champs sont également affichées dans la zone "Détails" de l'application, sur la page "Mes applications" du développeur:

Le développeur peut également modifier les valeurs en sélectionnant le lien "Modifier" de l'application sur la page "Mes applications".

Les procédures ci-dessous décrivent comment configurer les formulaires de création d'applications à l'aide de l'interface administrateur. Un développeur Drupal peut effectuer des personnalisations supplémentaires, y compris modifier la page "Mes applications", à l'aide de hooks personnalisés. Pour en savoir plus sur les comportements de modification via le code, consultez les exemples d'API d'application dans le fichier: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

Pour ajouter un champ au formulaire d'inscription de l'application:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Assurez-vous que le module Gestion des attributs d'application DevConnect est activé.
3. Sélectionnez Configuration > Paramètres du portail de développement > Attributs de l'application du portail de développement dans le menu d'administration de Drupal.
4. Sélectionnez le bouton Ajouter un attribut d'application au portail de développement en haut de la page.
5. Configurez le champ. Par exemple, pour le champ "Numéro client" ci-dessus, utilisez les paramètres suivants :
   • Nom interne = cust_id. Il s'agit du nom de la variable utilisée pour stocker la valeur du champ.
   • Nom public = numéro client
   • Description = saisissez votre numéro client.
   • Cochez la case "Exiger cet attribut".
   • Cochez la case Afficher cet attribut.
   • Widget = Zone de texte
   • Sélectionnez "Enregistrer" pour revenir à la page des attributs d'application du portail des développeurs.
6. Sélectionnez Enregistrer les modifications.
7. Sélectionnez l'icône Accueil > Vider tous les caches dans le menu Drupal.
   Vous devrez peut-être vider le cache de votre navigateur pour que le nouveau champ apparaisse sur le formulaire.

Pour ajouter un champ facultatif permettant au développeur de spécifier la plate-forme de l'application, définissez les attributs du champ comme suit:

• Nom interne = Use_platforms
• Nom public = Plates-formes
• Description = spécifiez une ou plusieurs plates-formes pour votre application.
• Décochez les cases "Exiger cet attribut".
• Cochez la case "Afficher cet attribut".
• Widget = Liste des cases à cocher
• Sélectionnez "Enregistrer" pour revenir à la page des attributs d'application du portail des développeurs.

Pour réorganiser les attributs du formulaire:

1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
2. Sélectionnez Configuration > Paramètres du portail de développement > Attributs de l'application du portail de développement dans le menu d'administration de Drupal.
3. Sélectionnez le symbole plus, + dans la colonne "Name" (Nom), puis faites glisser la propriété à l'emplacement où vous souhaitez l'afficher dans le formulaire.
4. Enregistrez les modifications.