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

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

El portal de servicios para desarrolladores actúa como un cliente de Apigee Edge. Eso 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 es necesario, el portal realiza una solicitud HTTP o HTTPS para recuperar información de Edge o enviarla a Edge.

Edge no realiza solicitudes al portal, solo responde a aquellas que se hacen 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

El portal necesita tres datos 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 siguiente formato: http://EdgePrivateCloudIp:8080/v1 o https://EdgePrivateCloudIp:TLSport/v1.

    EdgePrivateCloudIp es la dirección IP del servidor del servidor de Edge Management Server y TLSport es el puerto TLS/SSL para 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. La organización se configura cuando creas tu cuenta en Edge.
  • Nombre de usuario y contraseña de un administrador del desarrollador

    Las llamadas del portal a Edge se autentican y requieren un usuario con privilegios de administrador del desarrollador. Cuando se te aprovisiona un portal para desarrolladores, el rol de Administrador de desarrollador se agrega a tu organización. Esta función, que incluye a un usuario único llamado devadmin+{org_name}@apigee.com, tiene el único propósito de 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., debe mantenerse sincronizado con tu organización de Edge mediante llamadas a la API de administración que requieren autenticación. El “usuario” del administrador de desarrollo tiene los permisos necesarios.

Para ver la información de conexión, haz lo siguiente:

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

Sigue estos pasos para cambiar la configuración:

La forma de cambiar la configuración depende de la instalación del portal y de la versión del portal:

  • Instalación basada en la nube de la versión 15.01.06 y posteriores del portal: Debes realizar una solicitud al equipo de asistencia de Apigee Edge para cambiar la información de conexión. Por ejemplo, si deseas cambiar el nombre de la organización.
  • Instalación local y portal basado en la nube anteriores 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 de 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 sea correcta.
  6. Selecciona Save Configuration.

Garantiza 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 este pueda acceder a Edge. El portal inicia la comunicación con Edge mediante solicitudes de REST a través de HTTP y HTTPS. Por ejemplo, cuando un desarrollador registra una app nueva en el portal, este envía una solicitud a Edge para enviar información sobre la app a Edge.

Edge y el portal se pueden implementar en la nube o de forma local, y puedes combinar tipos de implementaciones. Por ejemplo, puedes implementar en la nube, de forma local, o implementar una en la nube y otra en el entorno local:

  • Si Apigee implementa tanto el portal como 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 este pueda realizar solicitudes a Edge, sin importar si Edge se implementa en la nube o de manera local.
  • Si implementas Edge de forma local, debes asegurarte de que el portal tenga acceso a Edge. Esto significa que el servidor Edge debe aceptar solicitudes del portal sin importar si este se implementa en la nube o de forma local.

Video: Mira un video breve a fin de obtener más información sobre cómo el portal para desarrolladores se comunica con Apigee Edge y garantizar 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 de forma correcta, Edge mostrará 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 su lugar, 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, este 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 aplicaciones. Para propagar la página Mis apps, el portal envía una solicitud a Edge a fin de recuperar información sobre las apps y las claves de API del desarrollador. 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 con la IU de Edge. Por ejemplo, un administrador puede realizar las siguientes acciones:

  • Cómo agregar, quitar o modificar la app de un desarrollador
  • Cómo revocar o aprobar una clave de API para una app

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

Administración de 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 realidad tanto en Edge como 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 enviada desde el portal

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

  • Contraseña del portal
  • Estado de la cuenta del portal: activo o bloqueado
  • Rol del portal: usuario autenticado, administrador y otro
  • Permisos basados en roles: Determina las acciones que el desarrollador puede realizar en el portal

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

Debido a que el portal almacena toda la información sobre un desarrollador, considera el portal como el sistema de registro de la información del desarrollador, no como 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.

Sincronización de desarrolladores de apps entre el portal y Edge

Edge no inicia la comunicación con el portal. Si, como administrador de Edge, manipulas la 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 en el portal desde Edge. Sin embargo, si solo modificas a los desarrolladores en el portal y no en Edge, nunca deberías tener que realizar esta sincronización. Además, debido a que Edge no te permite configurar una contraseña cuando creas un desarrollador, todos los desarrolladores creados en Edge tienen la contraseña del portal establecida en un valor aleatorio. Por lo tanto, el desarrollador debe realizar el proceso de recuperación de contraseña antes de poder 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 de creación de contenido.
  • Selecciona Personas en el menú de administración de Drupal.
  • Selecciona el botón Sincronización para desarrolladores del Portal para desarrolladores en la parte superior de la página a fin de sincronizarla con los desarrolladores de apps en Edge.