Crear un 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 gestionar el acceso a tus APIs, así como para fomentar tu comunidad de desarrolladores de aplicaciones.

Todos los usuarios de Apigee tienen acceso a las herramientas de desarrollo de portales integradas, lo que les permite crear su propio portal de desarrollo rápidamente, como alternativa al desarrollo de portales basado en Drupal. Para ver una comparación de funciones, consulta Comparación de las funciones del portal para desarrolladores.

Características y ventajas principales

El portal integrado te ofrece las siguientes funciones y ventajas clave:
Función Ventajas
Desarrollo del 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
  • Usar Markdown y HTML para redactar contenido
  • Añadir menús para desplazarse por el portal
Aspecto del portal Personaliza por completo el aspecto de tu portal con hojas de estilo SCSS y branding personalizado.
Documentación de la API Genera automáticamente documentación de referencia de APIs a partir de tus especificaciones de OpenAPI.
Registro de autoservicio Ofrece un registro de autoservicio para que los desarrolladores puedan crear aplicaciones con tus APIs.
Gestión de audiencias Controlar quién puede acceder al contenido y a las APIs del portal
Analytics Configurar Google Analytics y el seguimiento de analíticas personalizadas.
Personalizaciones avanzadas Realizar personalizaciones avanzadas del portal, como las siguientes:
  • Personalizar tu dominio
  • Añadir campos de registro personalizados
  • Ampliar un portal con secuencias de comandos
  • Configurar el correo

Cómo aborda Apigee la seguridad en el portal integrado

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

Función Direcciones
Requiere HTTPS y seguridad en la capa de transporte (TLS) Fuerza la comunicación cifrada
Incluye el registro de dominio apigee.io con la lista de sufijos públicos No permite que se definan supercookies en los subdominios de apigee.io.
Requisitos:
  • Saneamiento de entradas de formularios
  • Inyección de JavaScript en todo el sitio restringida a los administradores
Protege frente a ataques de inyección de HTML, SQL o backend
Incluye el encabezado x-content-type-options: nosniff XSS Impide que los navegadores intenten adivinar los tipos MIME.
Incluye el encabezado x-frame-options: deny XSS No permite insertar contenido del portal en un iframe.
Incluye el encabezado x-xss-protection: 1 XSS Impide que las páginas se carguen cuando detectan ataques de cross-site scripting (XSS) reflejado.
Usa tokens de CSRF. Protege frente a la falsificación de solicitudes entre sitios.
Ventajas: Protección de los datos de los clientes

Cómo se comunica el portal integrado con Apigee

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

En las siguientes secciones se proporciona más información.

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

Cuando un usuario del portal completa el proceso de registro de la aplicación en el portal integrado, el portal envía información sobre la aplicación a Apigee, incluido el nombre de la aplicación y los productos de API asociados a ella. Si Apigee registra la aplicación correctamente, devuelve una única clave de API al portal. El usuario del portal usa esa clave de API para acceder a los productos de API asociados a la aplicación.

La información sobre las aplicaciones y las claves de API solo se almacena en Apigee, no en el portal. Cuando un usuario del portal usa el portal para ver información sobre una aplicación (por ejemplo, a través de la página Mis aplicaciones), el portal envía una solicitud a Apigee con la clave de API para acceder a la información.

Del mismo modo, cuando un usuario del portal añade, quita o modifica una aplicación, el portal envía las modificaciones a Apigee para que se almacenen.

Como toda la información sobre las aplicaciones y las claves de API se almacena en Apigee, un administrador de Apigee puede modificarla mediante la interfaz de usuario o la API de gestión de Apigee. Por ejemplo, un administrador puede hacer lo siguiente:

  • Añadir, quitar o modificar una aplicación de desarrollador
  • Aprobar o revocar una clave de API de una aplicación de desarrollador

Para obtener más información, consulta el artículo Controlar el acceso a las APIs registrando aplicaciones.

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

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

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

  • Nombre y apellidos
  • Dirección de correo electrónico
  • Nombre de usuario
  • Estado de la cuenta del portal (activa o inactiva)
  • Rol en el portal (usuario autenticado, administrador u otro)
  • Permisos basados en roles
  • Equipos de los que el usuario del portal es miembro (si te has registrado en la versión preliminar de la función de equipos)

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

Para obtener más información, consulta Registrar desarrolladores de aplicaciones.

Dónde se almacena la información del equipo de desarrollo (vista previa)

Cuando un usuario del portal crea un equipo de desarrolladores en el portal, la información del equipo de desarrolladores se almacena en Apigee, lo que incluye:

  • Nombre y descripción del equipo de desarrolladores
  • Miembros del equipo de desarrollo y sus roles
  • Aplicaciones a las que se ha asignado el equipo de desarrollo
  • Audiencias asignadas al equipo de desarrollo
  • Hora a la que se creó el equipo de desarrolladores

Se genera una dirección de correo única y automática para el equipo de desarrolladores, que sirve como clave principal que usa Apigee para identificar al equipo de desarrolladores.

Para obtener más información, consulta los artículos Compartir la responsabilidad de una aplicación con equipos de desarrolladores (vista previa) y Gestionar equipos de desarrolladores.

Acerca del portal de ejemplo

Cuando creas un portal, se te proporciona un conjunto de páginas de inicio que puedes usar como punto de partida. Las páginas de inicio contienen contenido de demostración para ayudarte a desarrollar tu propio portal a medida que sustituyes el texto y las imágenes por tu contenido único. El tema del portal de muestra usa temas de diseño de material y SCSS.

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

Las páginas de inicio que se proporcionan con el portal de muestra incluyen lo siguiente:

Página Descripción
Inicio Página principal del portal que describe las APIs que se muestran. Se usa como página principal predeterminada de tu portal (index.html). Muestra el uso de los componentes de Angular Material, tal como se describe en Añadir componentes de Angular Material.
Empezar Página de contenido de muestra. Consulta cómo editar esta página y añadirla a la navegación superior siguiendo el tutorial.
APIs Lista de APIs disponibles. Cuando generas documentación de referencia de la API interactiva, los enlaces al contenido se añaden automáticamente a esta página.

Nota: El contenido de esta página se genera automáticamente en función de las APIs que publiques en tu portal. No puedes editar el contenido de esta página directamente, ya que no aparece en la lista de páginas. Puedes modificar el estilo de la página con el editor de temas del portal.
Mis aplicaciones Lista de aplicaciones registradas de un usuario autorizado. Consulta Cómo interactúan los usuarios con tu portal.

Nota: El contenido de esta página se genera automáticamente en función de las aplicaciones de usuario registradas. No puedes editar el contenido de la página directamente, ya que no aparece en la lista de páginas. Puedes modificar el estilo de la página con el editor de temas.
Iniciar sesión Página de inicio de sesión para usuarios registrados. Los usuarios nuevos pueden registrarse en esta página haciendo clic en Crear una cuenta. Consulta Cómo interactúan los usuarios con tu portal.

Nota: La página de inicio de sesión se incluye automáticamente en tu portal. Puedes personalizar el logotipo de la página de inicio de sesión y añadir campos de registro personalizados a la página de creación de cuenta. No puedes editar el contenido de la página directamente, ya que no aparece en la lista de páginas. "
Términos y condiciones Página de términos y condiciones de ejemplo.