Compilar tu portal integrado

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Apigee ofrece un portal integrado y fácil de usar para documentar y administrar el acceso a tus API, además de fomentar la comunidad de desarrolladores de apps.

Todos los usuarios de Apigee tienen acceso a las herramientas de desarrollo del portal integrado, lo que les permite compilar su propio portal de desarrolladores con rapidez. Esto brinda una alternativa al desarrollo de portales basados en Drupal. A fin de obtener una comparación de funciones, consulta Comparación de las características del portal para desarrolladores.

Video: Mira este video breve para obtener una introducción a la creación y publicación de tu portal integrado.

Funciones y beneficios clave

El portal integrado le ofrece las siguientes funciones y beneficios clave:
Atributo Ventajas
Desarrollo de contenido del portal Desarrolla el contenido de tu portal de forma rápida y sencilla.
  • Crea páginas con el editor de páginas fácil de usar
  • Usa Markdown y HTML para redactar contenido
  • Agrega menús para navegar por el portal
Aspecto del portal Personaliza por completo el aspecto de tu portal con hojas de estilo SCSS y desarrollo de la marca personalizados.
Documentación de la API Genera automáticamente la documentación de referencia de la API según tus especificaciones de OpenAPI.
Registro autoservicio Proporciona un registro autoservicio para que los desarrolladores creen aplicaciones con tus API.
Administración de públicos Controla quién puede acceder al contenido y a las API del portal
Análisis Configurar Google Analytics y el seguimiento personalizado de estadísticas
Personalización avanzadas Realiza personalizaciones avanzadas del portal, incluidas las siguientes opciones:
  • Personaliza tu dominio
  • Agrega campos de registro personalizados
  • Extiende tu portal con secuencias de comandos
  • Configura tu correo electrónico

Cómo Apigee aborda la seguridad en el portal integrado

En la siguiente tabla, se describe cómo Apigee aborda la seguridad a través de funciones incorporadas en el portal integrado.

Atributo Direcciones
Requiere HTTPS y seguridad de la capa de transporte (TLS) Aplica comunicación encriptada
Incluye el registro de dominios apigee.io con la Lista de sufijos públicos No permite que se establezcan “supercookies” en subdominios de apigee.io
Requiere
    .
  • Limpieza de los datos ingresados en el formulario
  • Inyección de JavaScript en todo el sitio restringida a administradores
Protección contra ataques de inyección HTML, SQL o backend
Incluye encabezado XSSx-content-type-options: nosniff No permite que los navegadores intenten adivinar tipos de MIME
Incluye encabezado XSSx-frame-options: deny No permite incorporar contenido del portal en un iframe.
Incluye encabezado XSS x-xss-protection: 1 No permite que las páginas se carguen cuando detectan ataques reflejados en las secuencias de comandos entre sitios (XSS).
Usa tokens de CSRF Protección contra la falsificación de solicitudes entre sitios
Aprovecha: Protección de datos de clientes

Cómo el portal integrado se comunica con Apigee

La mayor parte de la información que usa el portal para desarrolladores se almacena en Apigee. El portal actúa como un cliente para Apigee. Según sea necesario, el portal para desarrolladores envía una solicitud HTTP o HTTPS de REST a fin de recuperar información o enviarla a Apigee. Por ejemplo, cuando un usuario del portal registra una nueva app en el portal, este envía una solicitud a Apigee para que almacene información sobre ella.

En las siguientes secciones, se proporcionan más detalles.

Dónde se almacenan el registro de la app y las claves de API

Cuando un usuario del portal completa el proceso de registro de apps en el portal integrado, el portal envía información sobre la app a Apigee, incluidos el nombre de esta y los productos de API asociados con la app. Si Apigee registra la app correctamente, Apigee le muestra al portal una sola clave de API. El usuario del portal usa esa clave de API para acceder a los productos de API asociados con la app.

La información sobre las apps y las claves de API se almacena solo en Apigee; no está almacenado en el portal. Cuando un usuario del portal usa el portal para ver información sobre una aplicación, a través de la página Mis aplicaciones, por ejemplo, el portal solicita a Apigee una clave de API para acceder a la información.

Del mismo modo, cuando un usuario del portal agrega, quita o modifica una app, el portal envía las modificaciones a Apigee para que se almacenen.

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

  • Agrega, quita o modifica una app de desarrollador
  • Aprueba o revoca una clave de API para una app de desarrollador

Si deseas obtener más información, consulta Controla el acceso a tus API mediante el registro de apps.

Dónde se almacena la información de la cuenta de desarrollador

La información de la cuenta de desarrollador se almacena en Apigee, de la siguiente manera:

La siguiente información de cuenta de usuario se almacena en Apigee:

  • Nombre y apellido:
  • Dirección de correo electrónico
  • Nombre de usuario
  • Estado de la cuenta del portal (activa o inactiva)
  • Función del portal (usuario autenticado, administrador, etcétera)
  • Permisos basados en roles
  • Equipos de los que el usuario del portal es miembro (si se inscribió en la versión beta de la función de equipos)

La dirección de correo electrónico es la clave primaria que usa Apigee para identificar al desarrollador, y cada una debe ser única. A partir de la clave primaria, Apigee genera un ID de desarrollador único para cada organización a la que pertenece el desarrollador.

Para obtener más información, consulta Registra desarrolladores de apps.

Dónde se almacena la información del equipo de desarrolladores (beta)

Cuando el usuario de un portal crea un equipo de desarrolladores, la información de este se almacena en Apigee, incluida la siguiente:

  • Nombre y descripción del equipo de desarrolladores
  • Miembros del equipo de desarrolladores y sus funciones
  • Apps a las que se asigna el equipo de desarrolladores
  • Públicos asignados al equipo de desarrolladores
  • Hora en la que se creó el equipo de desarrolladores

De forma automática, se genera una dirección de correo electrónico única para el equipo de desarrolladores. Esta funciona como la clave primaria que utiliza Apigee para identificar al equipo de desarrolladores.

Para obtener más información, consulta Comparte la responsabilidad de una app con los equipos de desarrolladores (beta) y Administra equipos de desarrolladores.

Información sobre elportal de muestra

Cuando creas un nuevo portal, se proporciona un conjunto de páginas de inicio para que puedas usarlas como punto de partida. Las páginas de inicio incluyen contenido de demostración que te ayuda a inspirar el desarrollo de tu propio portal a medida que reemplazas el texto y las imágenes con tu contenido único. El tema del portal de muestra utiliza temas de material design y SCSS.

A continuación, se muestra la página principal del portal de muestra.

Las páginas de inicio que se proporcionan con el portal de muestra incluyen las siguientes:

(EE.UU.): Descripción
Página principal Página principal del portal que describe las API que se muestran. Sirve como página principal predeterminada para el portal (index.html). Demuestra el uso de los componentes de material angular, como se describe en la sección sobre cómo agregar componentes angulares.
Comenzar Página de contenido de muestra. Obtén información sobre cómo editar esta página y agregarla a la barra de navegación superior; para ello, revisa el instructivo.
API Lista de API disponibles Cuando generas documentación de referencia de la API interactiva, los vínculos al contenido se agregan automáticamente a esta página.

Nota: El contenido de esta página se genera de forma automática en función de las API que publicas en tu portal. No puedes editar el contenido de esta página directamente. No aparece en la lista de páginas. Puedes modificar el estilo de la página con el editor de temas del portal.
Mis apps Lista de apps registradas para un usuario autorizado. Consulta Cómo interactúan los usuarios del portal con tu portal.

Nota: El contenido de esta página se genera de forma automática en función de las apps de usuario registradas. No puedes editar el contenido de la página directamente. No aparece en la lista de páginas. Puedes modificar el estilo de la página con el editor de temas.
Acceso Página de acceso para usuarios registrados. Los usuarios nuevos pueden registrarse desde esta página si hacen clic en Acceder. Consulta Cómo interactúan los usuarios del portal con tu portal.

Nota: La página de acceso se incluye automáticamente en tu portal. Puedes personalizar el logotipo en la página de acceso y agregar campos de registro personalizados a la página Crear cuenta. No puedes editar el contenido de la página directamente. No aparece en la lista de páginas. ”
Términos y condiciones Página de Términos y Condiciones de muestra