Configurer l'enregistrement de l'application

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

Les développeurs utilisent la page "Mes applications" du portail de services pour les développeurs pour enregistrer des applications. Les développeurs accèdent à la page "Mes applications" depuis le menu principal du portail:

Pour enregistrer une application, le développeur sélectionne le bouton "Ajouter une 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 entièrement le processus d'enregistrement des applications. Par exemple, vous pouvez configurer les éléments suivants:

• Liste des produits d'API disponibles sur le portail
• Indique si un produit d'API par défaut existe
• Indique si l'URL de rappel est obligatoire
• Indique si la clé API est approuvée manuellement ou automatiquement pour un produit d'API.
• Indique 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 d'applications pour votre portail. Toutefois, cette section n'explique pas comment créer des produits d'API. Pour en savoir plus, consultez les pages suivantes:

• Créer des produits API
• Utiliser l'API de gestion Edge pour publier des API

Vous pouvez configurer le portail pour empêcher les développeurs de créer, de supprimer ou de modifier des applications en fonction du rôle qui leur est attribué. Par exemple, vous pouvez configurer le portail pour qu'il crée une seule application par défaut pour tous les développeurs lorsqu'ils s'inscrivent. Vous n'autorisez ensuite 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 les développeurs autorisés à créer, supprimer et modifier des applications. Pour en savoir plus, consultez Ajouter et gérer des comptes utilisateur.

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

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

• Spécifier le niveau d'accès lors de la création d'un produit d'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 d'API

Lorsque vous créez un produit d'API, vous spécifiez l'option de niveau d'accès du produit, comme illustré 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 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 pouvant accéder à chaque produit d'API.

Pour restreindre l'accès à un produit 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 du portail de développement et les attributions d'utilisateurs :
   • Sélectionnez Personnes > Autorisations > Rôles dans le menu d'administration de Drupal, puis ajoutez ou modifiez les rôles et les autorisations des développeurs, si nécessaire.
   • Sélectionnez Personnes 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 des développeurs > Accès aux rôles de produit d'API dans le menu d'administration Drupal.
4. Sélectionnez les rôles auxquels vous souhaitez accorder l'accès à chaque produit d'API.
5. Cliquez sur Enregistrer la configuration.

Configurer la façon dont un développeur associe des produits d'API à une application

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

En fonction de la configuration du portail, le développeur peut sélectionner un ou plusieurs produits d'API à associer à l'application au moment de son 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 pas d'applications à 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 pas ajouter d'autres produits d'API à l'application.
• Autorisez la sélection d'un seul produit d'API, mais ne l'exigez pas.
• Exiger la sélection d'un seul produit d'API.
• Autorisez la sélection de plusieurs produits d'API, mais n'en exigez aucun.
• Autorisez la sélection de plusieurs produits d'API et exigez-en au moins un.

Vous pouvez également contrôler l'élément HTML qui s'affiche sur le formulaire que le développeur utilise pour sélectionner le produit d'API. Plusieurs options sont disponibles :

• Listes déroulantes
• Cases à cocher ou cases d'option Des cases à cocher s'affichent lorsque le développeur peut sélectionner plusieurs produits d'API, et des boutons radio s'affichent lorsqu'il ne peut en sélectionner qu'un seul.

Pour définir l'option de sélection des produits d'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 > 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 de l'application", développez la section 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'autorisation 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 désignée pour 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 lorsqu'il demande des codes d'autorisation et des jetons d'accès. Le paramètre redirect_uri doit correspondre à celui enregistré. Pour en savoir plus, consultez la section Mettre en œuvre le type d'attribution du code d'autorisation.

Pour contrôler l'URL de rappel pour la sélection de produits d'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 > 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 section Paramètres de l'URL de rappel.
4. Sous Gestion de l'URL de rappel, sélectionnez l'une des options suivantes.
   • L'URL de rappel est obligatoire pour toutes les applications de développement.
   • L'URL de rappel est facultative pour toutes les applications de développeur.
   • L'URL de rappel n'est ni obligatoire ni affichée.
5. Enregistrez la configuration.

Afficher les données analytiques sur l'utilisation de l'application

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 min.
• Nombre de messages
• Nombre d'erreurs

Pour activer les données analytiques 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 > Dev Portal > Paramètres de l'application) dans le menu d'administration de Drupal.
3. Sur la page "Paramètres des applications", développez la section Paramètres de performances de l'application.
4. Cochez la case Afficher l'onglet "Développeur" des données analytiques sur les applications.
5. Sélectionnez Test ou Production pour Environnement pour interroger les données analytiques. Pour un portail accessible au public, vous sélectionnez généralement Production.
6. Enregistrez la configuration.

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

1. Sélectionnez le nom de l'application sur la page "Mes applications".
2. Sélectionnez l'association Analytics pour l'application.
3. Sélectionnez le type d'analyse à afficher et la période:
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 l'enregistre, le portail lui renvoie 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 d'API lorsque vous le créez:

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 ensuite révoquer une clé approuvée automatiquement.
• Manuelle : une clé API est renvoyée par le portail lorsque le développeur enregistre l'application, mais la clé n'est pas activée pour les produits d'API qui utilisent l'approbation manuelle des clés. Un administrateur doit approuver manuellement la clé API, soit dans l'UI de gestion Edge, soit dans l'API, avant que le développeur ne puisse l'utiliser pour accéder au produit d'API. Vous pouvez ensuite révoquer une clé approuvée manuellement.

Pour en savoir plus, consultez 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 utiliser immédiatement 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, un développeur sélectionne le nom de l'application sur la page "Mes applications", puis le lien "Produits" :

Dans cet exemple, le produit d'API Météo Premium 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 API) dans le menu déroulant en haut à droite.
3. Sélectionnez Publier > Applications de développeur pour ouvrir la liste des applications de développeur.
4. Sélectionnez le bouton En attente pour afficher la liste des applications dont les demandes de clés sont 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 Modifier en haut à droite.
7. Dans la liste des produits d'API de 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 désormais approuvée.

Contrôler le stockage en cache du produit API et de l'application

Les informations sur les produits d'API et les applications de développeur sont stockées à distance du portail sur Apigee Edge. Cela signifie que les modifications apportées aux produits et applications d'API peuvent être effectuées à partir de l'UI ou de l'API Edge, sans passer par le portail. Par exemple, lorsqu'un administrateur backend ajoute un nouveau produit d'API, ces informations ne sont pas immédiatement mises à jour dans le portail.

Pour vous assurer que le portail reste synchronisé avec le backend Edge, vous pouvez déclencher manuellement une mise à jour du cache du portail, mettre à jour les caches automatiquement lorsque la tâche Cron du portail s'exécute, ou les deux. Par exemple, si vous configurez la tâche Cron pour qu'elle s'exécute fréquemment, par exemple toutes les cinq ou dix minutes, vous ne souhaiterez peut-être pas avoir à mettre à jour les produits API et les caches d'applications de développement aussi fréquemment. 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 n'aura peut-être pas beaucoup d'impact.

Par défaut, le portail est configuré pour reconstruire les caches du produit d'API et de l'application du développeur à chaque exécution de cron.

Pour spécifier si vous devez ou non reconstruire les caches du produit d'API et de l'application de développement chaque fois que cron s'exécute:

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 > Paramètres du portail de développement > Paramètres de l'application.
3. Cochez ou décochez l'option Réorganiser les caches du produit 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 qu'un ID 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
• Affichées par différents éléments HTML, tels que des zones de texte, des cases d'option, des cases à cocher, etc.
• Peut être défini pour s'afficher n'importe où sur le formulaire entre le champ "URL de rappel" et le champ "Produit"

Par exemple, le formulaire suivant affiche un champ obligatoire pour l'ID client et un champ facultatif pour la plate-forme cible:

Lorsque vous ajoutez des champs au formulaire, les valeurs des champs sont automatiquement importé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 y accéder à partir d'un script.

Par exemple, pour afficher les nouveaux champs de formulaire dans l'interface utilisateur de gestion Edge, accédez à "Publier" > "Applications de développeur", puis sélectionnez le nom de l'application. Les nouvelles valeurs de champ s'affichent dans la zone "Attributs personnalisés" de la page avec un nom correspondant au nom interne du champ:

Les valeurs des champs s'affichent également 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 crochets personnalisés. Pour en savoir plus sur la modification des comportements 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 du portail de développement en haut de la page.
5. Configurez le champ. Par exemple, pour le champ "ID client" affiché ci-dessus, utilisez les paramètres suivants :
   • Internal Name = 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 "Attributs de l'application" du portail développeur.
6. Sélectionnez Enregistrer les modifications.
7. Dans le menu Drupal, sélectionnez l'icône Accueil > Vider tous les caches.
   Vous devrez peut-être vider le cache de votre navigateur avant que le nouveau champ n'apparaisse dans 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:

• Internal Name = intended_platforms
• Public Name (Nom public) = Platforms (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 de cases à cocher
• Sélectionnez "Enregistrer" pour revenir à la page "Attributs de l'application" du portail développeur.

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 + sous la colonne "Nom", puis faites glisser la propriété à l'emplacement où vous souhaitez l'afficher dans le formulaire.
4. Enregistrez les modifications.