Portales de API Gateway - Amazon API Gateway
Consideraciones

Portales de API Gateway

Puede usar el portal de una API Gateway para compartir las API y la documentación de API con los consumidores de API en una página web. Un portal contiene un conjunto de productos de portal. Cada producto del portal es una agrupación lógica de API de REST y contiene la documentación que usted crea y publica para los consumidores de API. Las páginas de productos de un portal contienen la documentación personalizada por producto del portal. Las páginas de puntos de conexión REST de los productos contienen la documentación de cada una de las API de REST y la ruta, el método y la fase de una API de REST. La combinación de páginas de productos y páginas de puntos de conexión REST de productos proporciona la documentación completa que permite a los consumidores de API obtener información sobre cómo empezar a utilizar las API de REST.

Use un portal para hacer lo siguiente:

  • Utilice API Gateway durante todo el ciclo de vida de las API, desde la creación de las API hasta su documentación y distribución.

  • Comparta los productos del portal entre cuentas de AWS.

  • Personalice y comparta una ubicación central para los productos del portal y proporcione páginas de productos.

Consideraciones

Es posible que las siguientes consideraciones afecten al uso de los portales de API Gateway:

  • Solo puede crear portales para compartir las API de REST.

  • Los portales se crean por región de AWS. El portal solo puede contener las API de REST que estén en la misma región en la que crea el portal.

  • Solo puede usar los Consola de administración de AWS, AWS CLI o AWS SDK para crear y compartir los portales.

  • Solo puede controlar el acceso al portal con grupos de usuarios de Amazon Cognito. Los consumidores del portal pueden iniciar sesión directamente a través de un grupo de usuarios o pueden federarse a través de un proveedor de identidades (IdP) externo. Si utiliza un grupo de usuarios de Amazon Cognito, no puede establecer un secreto de cliente para el grupo de usuarios. Para obtener más información, consulte Grupos de usuarios de Amazon Cognito.