Communication entre un portail basé sur Drupal et Edge

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

Le portail des services pour les développeurs agit en tant que client d'Apigee Edge. Cela signifie que le portail ne fonctionne pas comme un système autonome. En revanche, la majeure partie des informations utilisées par le portail est stockée sur Edge. Si nécessaire, le portail envoie une requête HTTP ou HTTPS pour récupérer des informations depuis Edge ou pour les envoyer à Edge.

Edge n'envoie pas de requêtes au portail. Il ne répond qu'aux requêtes effectuées depuis le 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 doit communiquer trois informations 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 l'installation dans un cloud privé, l'URL se présente sous la forme http://EdgePrivateCloudIp:8080/v1 ou https://EdgePrivateCloudIp:TLSport/v1.
  
  où EdgePrivateCloudIp est l'adresse IP du serveur Edge Management Server et TLSport est 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 développeur
  
  Les appels du portail vers Edge sont authentifiés et nécessitent un utilisateur disposant des droits d'administrateur développeur. Lorsqu'un Developer Portal est provisionné pour vous, le rôle d'administrateur du Developer Portal est ajouté à votre organisation. Ce rôle, qui inclut un seul utilisateur appelé devadmin+{org_name}@apigee.com, a pour seul but de connecter votre Developer Portal à votre organisation Edge. Étant donné que le portail affiche vos applications de développeur Edge, vos produits d'API, etc., il doit rester synchronisé avec votre organisation Edge en effectuant des appels d'API de gestion nécessitant 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 et de la version du portail:

• Installation basée sur le cloud de la version 15.01.06 du portail ou version 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érieur à 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 de gestion.
3. Saisissez l'URL du point de terminaison Edge dans URL du point de terminaison de l'API de gestion.
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 que la connexion est effective.
6. Sélectionnez Enregistrer la configuration.

Assurer l'accès à Edge depuis le 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 y accéder. Le portail lance la communication avec Edge en envoyant des requêtes REST via HTTP et HTTPS. Par exemple, lorsqu'un développeur enregistre une nouvelle application sur le portail, celui-ci envoie une requête à Edge pour lui envoyer des informations sur l'application.

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 les déployer à la fois dans le cloud et sur site, ou en déployer un dans le cloud et un sur site:

• Si le portail et Edge sont tous deux déployés par Apigee dans le cloud, vous ne devriez rencontrer aucun problème pour envoyer des requêtes du portail à Edge.
• Si vous déployez le portail sur site, vous devez vous assurer qu'il peut envoyer des requêtes à Edge, que ce soit 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 le portail 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 API associés à l'application.

Si Edge enregistre correctement l'application, il renvoie une seule clé API au portail. Le développeur utilise ensuite cette clé API pour accéder aux produits 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 à la page "Mes applications". Pour renseigner la page "Mes applications", le portail envoie une requête à Edge pour récupérer des informations sur les applications et les clés API du développeur. Ces informations s'affichent ensuite sur la page "Mes applications" du développeur dans 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 spécifiques aux applications et aux clés API sont stockées dans Edge, un administrateur Edge peut les manipuler à 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 apparaît à un administrateur dans l'interface utilisateur Edge:

Gérer les développeurs à partir du portail

Lorsqu'un développeur s'inscrit en tant qu'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 en fait stockées à la fois sur Edge et sur le portail.

Les informations de développeur stockées sur Edge incluent les suivantes:

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

Le portail stocke les mêmes informations qu'Edge, mais également des informations supplémentaires, y compris les suivantes:

• Mot de passe du portail
• État du compte sur le portail: actif ou bloqué
• Rôle sur le portail: utilisateur authentifié, administrateur, autre
• Autorisations basées sur le rôle: déterminent 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 responsable de l'authentification du développeur et de l'application des autorisations basées sur les rôles.

Étant donné que le portail stocke toutes les informations sur un développeur, considérez-le comme le système d'enregistrement des informations sur les développeurs, et non Edge. Lorsque le développeur modifie ses informations sur le portail, elles sont stockées sur le portail et, le cas échéant, envoyées à Edge. Par exemple, si le développeur change de prénom, ces informations sont envoyées à 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 n'établit pas de communication avec le portail. Si vous, en tant qu'administrateur Edge, manipulez des informations sur un développeur dans l'interface utilisateur Edge, il n'est pas garanti que ces informations seront transmises au 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 d'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, comme Edge ne vous permet pas de définir un mot de passe lorsque vous créez un développeur, le mot de passe du portail de chaque développeur créé sur Edge est défini sur une valeur aléatoire. Par conséquent, le développeur doit suivre la procédure 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 Personnes 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 les développeurs d'applications sur Edge.