Cómo establecer la comunicación entre un portal basado en Drupal y Edge

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X.
info

El portal de servicios para desarrolladores actúa como cliente de Apigee Edge. Esto significa que el portal no funciona como un sistema independiente. En cambio, gran parte de la información que usa el portal se almacena en Edge. Cuando sea necesario, el portal realizará una solicitud HTTP o HTTPS para recuperar información de Edge o enviarle información.

Edge no realiza solicitudes al portal, solo responde a las solicitudes realizadas desde el portal. Por lo tanto, el portal inicia todas las interacciones entre el portal y Edge.

Configura la conexión entre el portal y Edge

Hay tres datos de información que el portal necesita para comunicarse con Edge, como se indica a continuación.

  • URL del extremo de Edge

    El extremo predeterminado para la versión de Edge basada en la nube es https://api.enterprise.apigee.com/v1.

    Para la instalación de la nube privada, la URL tiene el formato http://EdgePrivateCloudIp:8080/v1 o https://EdgePrivateCloudIp:TLSport/v1.

    En la que EdgePrivateCloudIp es la dirección IP del servidor de Edge Management Server y TLSport es el puerto TLS/SSL de la API de Edge Management. Por ejemplo, 8443.
  • Nombre de la organización de Apigee

    Este es el nombre de tu organización en Edge. Configuras la organización cuando creas tu cuenta en Edge.
  • Nombre de usuario y contraseña de un administrador de desarrolladores

    Las llamadas del portal a Edge se autentican y requieren un usuario con privilegios de administrador de desarrolladores. Cuando se aprovisiona un portal para desarrolladores, se agrega el rol de administrador de desarrolladores a tu organización. Este rol, que incluye un solo usuario llamado devadmin+{org_name}@apigee.com, se creó solo para conectar tu portal para desarrolladores a tu organización de Edge. Debido a que el portal muestra tus apps para desarrolladores de Edge, productos de API, etcétera, debe mantenerse sincronizado con tu organización de Edge realizando llamadas a la API de administración que requieren autenticación. El "usuario" devadmin tiene los permisos necesarios.

Para ver la información de conexión, sigue estos pasos:

  1. En el menú de administración de Drupal, selecciona Configuración > Portal para desarrolladores > Configuración de la aplicación.

Para cambiar la configuración, haz lo siguiente:

La forma en que cambies la configuración depende de la instalación y la versión del portal:

  • Instalación basada en la nube de la versión 15.01.06 del portal y versiones posteriores: Debes realizar una solicitud a Asistencia de Apigee Edge para cambiar la información de conexión. Por ejemplo, si quieres cambiar el nombre de la organización.
  • Portal basado en la nube y de instalación local anterior a la versión 15.01.06: Cambia la información de conexión como se describe a continuación:
  1. En el menú de administración de Drupal, selecciona Configuración > Configuración del portal para desarrolladores.
  2. Ingresa el nombre de tu organización en Organización de la API de Management.
  3. Ingresa la URL del extremo de Edge en URL del extremo de la API de Management.
  4. Ingresa las credenciales del administrador de la organización en Endpoint Authenticated User y Authenticated User's Password.
  5. Selecciona Probar conexión para asegurarte de que la conexión se haya realizado correctamente.
  6. Selecciona Save Configuration.

Cómo garantizar el acceso a Edge desde el portal

Debido a que gran parte de la información que usa el portal se almacena en Edge, debes asegurarte de que el portal pueda acceder a Edge. El portal inicia la comunicación con Edge mediante solicitudes REST a través de HTTP y HTTPS. Por ejemplo, cuando un desarrollador registra una nueva app en el portal, este envía una solicitud a Edge para enviarle información sobre la app.

Tanto Edge como el portal se pueden implementar en la nube o de forma local, y puedes combinar tipos de implementaciones. Por ejemplo, puedes implementar ambos en la nube, ambos de forma local o uno en la nube y uno de forma local:

  • Si Apigee implementa el portal y Edge en la nube, no debería haber problemas para realizar solicitudes desde el portal a Edge.
  • Si implementas el portal de forma local, debes asegurarte de que el portal pueda realizar solicitudes a Edge, independientemente de si Edge se implementa en la nube o de forma local.
  • Si implementas Edge en las instalaciones, debes asegurarte de que el portal tenga acceso a Edge. Esto significa que tu servidor de Edge debe aceptar solicitudes del portal, independientemente de si el portal se implementa en la nube o de forma local.

Video: Mira un video breve para obtener más información sobre cómo el portal para desarrolladores se comunica con Apigee Edge y para asegurarte de que la conexión funcione.

Administra apps y claves de API desde el portal

Cuando el desarrollador completa el proceso de registro de la app en el portal, este envía información sobre la app a Edge, incluidos el nombre de la app y los productos de API asociados con ella.

Si Edge registra la app correctamente, muestra una sola clave de API al portal. Luego, el desarrollador usa esa clave de API para acceder a los productos de API asociados con la app.

En realidad, no se almacena información sobre las apps ni las claves de API en el portal. En cambio, toda esa información se almacena en Edge. Por lo tanto, cada vez que un desarrollador usa el portal para ver información sobre una app, el portal envía una solicitud a Edge para acceder a esa información. Cada vez que el desarrollador modifica una app, el portal envía automáticamente esas modificaciones a Edge.

Por ejemplo, un desarrollador accede al portal y navega a la página Mis apps. Para completar la página Mis aplicaciones, el portal realiza una solicitud a Edge para recuperar información sobre las apps y las claves de API del desarrollador. Luego, esa información aparece en la página Mis apps del desarrollador en el portal:

Si el desarrollador agrega, quita o modifica una app, el portal envía esas modificaciones a Edge.

Debido a que toda la información sobre las apps y las claves de API se almacena en Edge, un administrador de Edge puede manipular esa información mediante la IU de Edge. Por ejemplo, un administrador puede realizar las siguientes acciones:

  • Agrega, quita o modifica la app de un desarrollador
  • Revoca o aprueba una clave de API para una app

A continuación, se muestra la misma app, "Mi app del clima", tal como se ve a un administrador en la IU de Edge:

Cómo administrar desarrolladores desde el portal

Cuando un desarrollador se registra como un usuario nuevo del portal, se crea en Edge y en el portal. Por lo tanto, a diferencia de las apps y las claves de API, la información sobre los desarrolladores se almacena en Edge y en el portal.

La información del desarrollador almacenada en Edge incluye lo siguiente:

  • Nombre
  • Apellido
  • Dirección de correo electrónico
  • Información adicional opcional que se envía desde el portal

El portal almacena la misma información que Edge, pero también almacena información adicional, como la siguiente:

  • Contraseña del portal
  • Estado de la cuenta del portal: activa o bloqueada
  • Rol del portal: usuario autenticado, administrador, etcétera
  • Permisos basados en roles: Determinan las acciones que el desarrollador puede realizar en el portal.

Cuando un desarrollador accede al portal, este es el responsable de autenticarlo y de aplicar los permisos basados en roles.

Dado que el portal almacena toda la información sobre un desarrollador, considéralo como el sistema de registro de la información del desarrollador, no Edge. Cuando el desarrollador modifica su información en el portal, esta se almacena en el portal y, si corresponde, se envía a Edge. Por ejemplo, si el desarrollador cambia su nombre, esa información se envía a Edge. Sin embargo, si el desarrollador cambia su contraseña, esa información solo se almacena de forma local en el portal.

Para obtener más información, consulta Cómo agregar y administrar cuentas de usuario.

Sincroniza los desarrolladores de apps entre el portal y Edge

Edge no inicia la comunicación con el portal. Si, como administrador de Edge, manipulas información sobre un desarrollador en la IU de Edge, no hay garantía de cuándo se enviará esa información al portal. Por lo tanto, usa las funciones de administración del portal para crear, modificar y borrar desarrolladores, no Edge.

Un administrador del portal puede forzar una sincronización entre el portal y Edge para descargar información al portal desde Edge. Sin embargo, si solo modificas desarrolladores en el portal y no en Edge, nunca deberías tener que realizar esta sincronización. Además, como Edge no te permite establecer una contraseña cuando creas un desarrollador, cualquier desarrollador creado en Edge tiene su contraseña del portal establecida en un valor aleatorio. Por lo tanto, el desarrollador debe pasar por el proceso de recuperación de contraseña antes de que pueda acceder al portal.

Para sincronizar el portal con los desarrolladores de apps en Edge

:
  • Accede a tu portal como un usuario con privilegios de administrador o creación de contenido.
  • Selecciona Personas en el menú de administración de Drupal.
  • Selecciona el botón Sincronización de desarrolladores del portal para desarrolladores en la parte superior de la página para sincronizar con los desarrolladores de apps en Edge.