Communication entre un portail basé sur Drupal et Edge

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

Le portail des services pour les développeurs agit en tant que client pour Apigee Edge. Le portail ne fonctionne donc pas comme un système autonome. Au lieu de cela, une grande partie des informations utilisées par le portail sont effectivement stockées sur Edge. Si nécessaire, le portail effectue une requête HTTP ou HTTPS pour récupérer des informations auprès de Edge ou pour envoyer des informations à Edge.

Edge n'envoie pas de requêtes au portail, il répond uniquement aux requêtes effectuées à partir du portail. Par conséquent, toutes les interactions entre le portail et Edge sont initiées par le portail.

Configurer la connexion entre le portail et Edge

Le portail a besoin de trois éléments d'information pour communiquer avec Edge, comme indiqué ci-dessous.

• URL du point de terminaison Edge
  
  Le point de terminaison par défaut de la version cloud d'Edge est https://api.enterprise.apigee.com/v1.
  
  Pour une installation sur le cloud privé, l'URL se présente au format suivant: http://EdgePrivateCloudIp:8080/v1 ou https://EdgePrivateCloudIp:TLSport/v1.
  
  Où EdgePrivateCloudIp correspond à l'adresse IP du serveur Edge Management Server et TLSport le port TLS/SSL de l'API de gestion Edge. Par exemple, 8443.
• Nom de l'organisation Apigee
  
  Il s'agit du nom de votre organisation sur Edge. Vous configurez l'organisation lorsque vous créez votre compte sur Edge.
• Nom d'utilisateur et mot de passe d'un administrateur de développeur
  
  Les appels du portail à Edge sont authentifiés et nécessitent un utilisateur disposant des droits d'administrateur de développeur. Lorsqu'un portail des développeurs est configuré pour vous, le rôle Administrateur des développeurs est ajouté à votre organisation. Ce rôle, qui inclut un seul utilisateur nommé devadmin+{org_name}@apigee.com, a pour seul objectif de connecter votre portail des développeurs à votre organisation Edge. Étant donné que le portail affiche vos applications de développement Edge, vos produits d'API, etc., il doit rester synchronisé avec votre organisation Edge en effectuant des appels d'API de gestion qui nécessitent une authentification. L'utilisateur devadmin dispose des autorisations nécessaires.
  

Pour afficher les informations de connexion:

1. Dans le menu d'administration de Drupal, sélectionnez Configuration > Portail de développement > Paramètres de l'application.

Pour modifier la configuration:

La manière dont vous modifiez la configuration dépend de l'installation de votre portail et de la version du portail:

• Installation dans le cloud du portail version 15.01.06 ou ultérieure: vous devez envoyer une demande à l'assistance Apigee Edge pour modifier les informations de connexion. (par exemple, si vous souhaitez modifier le nom de l'organisation).
• Installation sur site et portail cloud antérieurs à la version 15.01.06: modifiez les informations de connexion comme décrit ci-dessous:

1. Dans le menu d'administration de Drupal, sélectionnez Configuration > Paramètres du portail de développement.
2. Saisissez le nom de votre organisation dans Organisation de l'API Management.
3. Saisissez l'URL du point de terminaison Edge dans le champ URL du point de terminaison de l'API Management.
4. Saisissez les identifiants de l'administrateur de l'organisation dans Utilisateur authentifié du point de terminaison et Mot de passe de l'utilisateur authentifié.
5. Sélectionnez Tester la connexion pour vous assurer qu'elle a bien été établie.
6. Sélectionnez Save Configuration (Enregistrer la configuration).

Assurer l'accès à Edge à partir du portail

Étant donné que la plupart des informations utilisées par le portail sont stockées sur Edge, vous devez vous assurer que le portail peut accéder à Edge. Le portail initie la communication avec Edge en effectuant des requêtes REST sur HTTP et HTTPS. Par exemple, lorsqu'un développeur enregistre une nouvelle application sur le portail, le portail envoie une requête à Edge pour envoyer des informations sur l'application à Edge.

Edge et le portail peuvent être déployés dans le cloud ou sur site, et vous pouvez combiner les types de déploiements. Par exemple, vous pouvez déployer les deux dans le cloud, sur site, ou en déployer une dans le cloud et l'autre sur site:

• Si le portail et Edge sont tous deux déployés par Apigee dans le cloud, il ne devrait y avoir aucun problème lors de l'envoi de requêtes depuis le portail vers Edge.
• Si vous déployez le portail sur site, vous devez vous assurer que le portail peut envoyer des requêtes à Edge, que ce dernier soit déployé dans le cloud ou sur site.
• Si vous déployez Edge sur site, vous devez vous assurer que le portail a accès à Edge. Cela signifie que votre serveur Edge doit accepter les requêtes du portail, que celui-ci soit déployé dans le cloud ou sur site.

Gérer les applications et les clés API à partir du portail

Lorsque le développeur termine le processus d'enregistrement de l'application sur le portail, le portail envoie des informations sur l'application à Edge, y compris le nom de l'application et les produits d'API associés à l'application.

Si Edge enregistre correctement l'application, Edge renvoie une seule clé API au portail. Le développeur utilise ensuite cette clé API pour accéder aux produits d'API associés à l'application.

Aucune information sur les applications et les clés API n'est stockée sur le portail. Au lieu de cela, toutes ces informations sont stockées sur Edge. Par conséquent, chaque fois qu'un développeur utilise le portail pour afficher des informations sur une application, le portail envoie une requête à Edge pour accéder à ces informations. Chaque fois que le développeur modifie une application, le portail envoie automatiquement ces modifications à Edge.

Par exemple, un développeur se connecte au portail et accède à sa page "Mes applications". Pour remplir la page Mes applications, le portail envoie une requête à Edge afin de récupérer des informations sur les applications et les clés API du développeur. Ces informations apparaissent ensuite sur la page "Mes applications" du développeur sur le portail:

Si le développeur ajoute, supprime ou modifie ensuite une application, le portail envoie ces modifications à Edge.

Étant donné que toutes les informations sur les applications et les clés API sont stockées sur Edge, un administrateur Edge peut manipuler ces informations à l'aide de l'interface utilisateur Edge. Par exemple, un administrateur peut :

• Ajouter, supprimer ou modifier l'application d'un développeur
• Révoquer ou approuver une clé API pour une application

Vous trouverez ci-dessous la même application, "My Weather App", telle qu'elle est présentée à un administrateur dans l'interface utilisateur Edge:

Gérer les développeurs à partir du portail

Lorsqu'un développeur s'inscrit en tant que nouvel utilisateur du portail, il est créé sur Edge et sur le portail. Par conséquent, contrairement aux applications et aux clés API, les informations sur les développeurs sont stockées à la fois sur Edge et sur le portail.

Les informations sur les développeurs stockées sur Edge incluent:

• Prénom
• Nom
• Adresse e-mail
• Informations supplémentaires facultatives envoyées depuis le portail

Le portail stocke les mêmes informations que Edge, mais il stocke également des informations supplémentaires, notamment:

• Mot de passe du portail
• État du compte du portail: actif ou bloqué
• Rôle de portail: utilisateur authentifié, administrateur, autre
• Autorisations basées sur les rôles: déterminez les actions que le développeur est autorisé à effectuer sur le portail

Lorsqu'un développeur se connecte au portail, c'est le portail qui est chargé de l'authentifier et de l'application des autorisations basées sur les rôles.

Étant donné que le portail stocke toutes les informations sur les développeurs, considérez-le comme le système d'enregistrement des informations sur les développeurs, et non comme Edge. Lorsque le développeur modifie ses informations sur le portail, ces informations sont stockées sur le portail et, le cas échéant, envoyées à Edge. Par exemple, si le développeur change son prénom, cette information est envoyée à Edge. Toutefois, si le développeur modifie son mot de passe, ces informations ne sont stockées que localement sur le portail.

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

Synchroniser les développeurs d'applications entre le portail et Edge

Edge ne communique pas avec le portail. Si, en tant qu'administrateur Edge, vous manipulez les informations concernant un développeur dans l'interface utilisateur Edge, rien ne garantit que ces informations seront transférées vers le portail. Par conséquent, utilisez les fonctionnalités d'administration du portail pour créer, modifier et supprimer des développeurs, et non Edge.

Un administrateur de portail peut forcer une synchronisation entre le portail et Edge pour télécharger des informations sur le portail à partir de Edge. Toutefois, si vous ne modifiez les développeurs que sur le portail et non sur Edge, vous ne devriez jamais avoir à effectuer cette synchronisation. De plus, étant donné que Edge ne vous permet pas de définir un mot de passe lorsque vous créez un développeur, tout développeur créé sur Edge a son mot de passe de portail défini sur une valeur aléatoire. Par conséquent, le développeur doit suivre le processus de récupération de mot de passe avant de pouvoir se connecter au portail.

Pour synchroniser le portail avec les développeurs d'applications sur Edge

:

• Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
• Sélectionnez People (Contacts) dans le menu d'administration de Drupal.
• Sélectionnez le bouton Dev Portal Developer Sync (Synchronisation des développeurs du portail de développement) en haut de la page pour synchroniser avec les développeurs d'applications sur Edge.