Creación de un portal en API Gateway - Amazon API Gateway
Elección de un nombre de dominioCreación de un portal

Creación de un portal en API Gateway

Un portal es una recopilación de productos. Usted controla la autorización, la marca y la publicación del portal. Al crear un portal, su estado de publicación es Disabled. Esto significa que el portal no se puede encontrar en la web. Para que los consumidores accedan al portal, debe publicarlo. Antes de publicar el portal, también puede obtener una vista previa.

API Gateway admite portales en los siguientes navegadores:

  • Firefox

  • Google Chrome

  • Microsoft Edge

  • Safari

Elección de un nombre de dominio

De forma predeterminada, la URL del portal está alojada en el siguiente nombre de dominio propiedad de Amazon:

https://p-portalId.apigw-portal.us-east-1.on.aws

Para personalizar el nombre de dominio, puede proporcionar un nombre de dominio que le pertenezca y un certificado SSL para el dominio personalizado. El certificado se debe administrar con AWS Certificate Manager (ACM) en Este de EE. UU. (Norte de Virginia) y debe ser compatible con Amazon CloudFront. Para obtener más información, consulte Requisitos para la utilización de certificados SSL/TLS con CloudFront.

Cuando utilice un nombre de dominio personalizado, API Gateway crea una distribución de CloudFront, protegida en tránsito con el certificado de ACM. Luego, API Gateway proporciona un registro de alias, que se debe agregar a la configuración de DNS. El registro de alias es el nombre de dominio propiedad de Amazon. Debe agregar este registro de alias para dirigir el tráfico a la distribución de CloudFront del dominio personalizado. El nombre de dominio que proporcione debe ser único y no estar utilizado ya en la lista de alias de una distribución de CloudFront existente.

Si usa su propio nombre de dominio, API Gateway usa la política de seguridad TLS_1_2 para proteger el portal. Para obtener más información, consulte Protocolos y cifrados admitidos entre lectores. No puede cambiar este valor.

Creación de un portal

Utilice la consola de API Gateway para crear y configurar el portal. Los procedimientos siguientes lo guiarán a través de todos los pasos necesarios. También puede elegir Saltar para revisar y crear al final del primer procedimiento para crear un portal vacío.

El procedimiento siguiente muestra cómo crear un portal. Primero, defina los detalles del portal.

Definición de los detalles del portal

  1. Inicie sesión en la consola de API Gateway, en https://console.aws.amazon.com/apigateway.

  2. En el panel de navegación principal, elija Portales.

  3. Elija Create portal (Crear portal).

  4. En detalles del portal, para el Nombre del portal, ingrese un nombre.

  5. Para Descripción del portal, ingrese una descripción.

  6. Para la autorización del portal, seleccione cómo autorizar el portal.

    • Si es la primera vez que crea un portal, le recomendamos que elija Ninguno. Si tiene pensado agregar alguna API de producción al portal, utilice Requerir autorización.

    • Para exigir a los consumidores del portal que se autentiquen para usar el portal, elija Requerir autorización y haga lo siguiente:

      1. Para el grupo de usuarios de Amazon Cognito, seleccione su grupo de usuarios.

        El grupo de usuarios debe estar en la misma región que el portal.

      2. Para ID de cliente de la aplicación, elija el ID del cliente de la aplicación.

        En el cliente de la aplicación, debe establecer la URL de devolución de llamada en la URL predeterminada del portal.

      3. Para el dominio del grupo de usuarios, ingrese el dominio del grupo de usuarios. Para obtener más información, consulte Configuración de un dominio de grupo de usuarios.

  7. Para la configuración del dominio, seleccione el nombre de dominio del portal.

    • Si es la primera vez que crea un portal, le recomendamos que elija Dominio predeterminado. Una vez que publique el portal, estará disponible en https://p-portalId.apigw-portal.us-east-1.on.aws.

    • Para proporcionar un nombre de dominio personalizado del que sea propietario, seleccione Nombre de dominio personalizado y haga lo siguiente:

      1. Para Nombre de dominio, escriba un nombre de dominio completo.

      2. Para Certificado de ACM, elija un certificado de ACM que cubra el nombre de dominio.

        Deberá agregar el registro de alias que API Gateway proporciona al registro de DNS para poder atender el tráfico del portal.

  8. Para agregar un monitor de aplicaciones de CloudWatch RUM al portal, para el monitor de aplicaciones de RUM, elija un monitor de aplicaciones. Para obtener más información, consulte CloudWatch RUM.

  9. Elija Siguiente.

Tras definir los detalles del portal, agregue los productos del portal. Puede cambiar los productos del portal en cualquier momento, pero tendrá que volver a publicar el portal para que los cambios surtan efecto.

Selección de los productos del portal

  1. En la lista de recursos, seleccione los productos que desee agregar al portal.

  2. Elija Siguiente.

Tras seleccionar los productos, personalice el diseño del portal. Para cargar un logotipo del portal, debe tener una imagen cargada en Amazon S3. Puede cambiar estos valores en cualquier momento, pero tendrá que volver a publicar el portal para que los cambios surtan efecto.

(Opcional) Personalización del portal

  1. Para logotipo del portal, proporcione el URI de S3 del archivo.

    Solo .svg, .png o .jpg son compatibles.

  2. Para personalizar el diseño del portal, tiene dos opciones:

    1. Puede elegir el tema del portal para aplicar un tema de color prediseñado al portal.

    2. Puede utilizar los selectores de color para seleccionar todas las opciones de diseño del portal.

  3. Elija Siguiente.

Tras seleccionar el diseño del portal, revise la información del portal.

Revisión del portal

  • Revise los ajustes en la página de revisión y creación. Cuando esté satisfecho con la configuración, elija Create (Crear).

Si utiliza un grupo de usuarios de Amazon Cognito para controlar el acceso al portal, debe establecer la URL de devolución de llamada en la URL predeterminada del portal en el cliente de la aplicación. Para obtener más información, consulte Application-specific settings with app clients.

El portal no estará disponible para los consumidores una vez que lo haya creado. Debe publicar el portal para que esté accesible en Internet. Para obtener más información, consulte Publicación de un portal en API Gateway.