Criar um portal no API Gateway
Portal é uma coleção de produtos. Você controla a autorização, a identidade visual e a publicação do seu portal. Quando você cria um portal, seu status de publicação é Disabled. Isso significa que seu portal não pode ser descoberto na Web. Para os consumidores acessarem seu portal, você precisa publicá-lo. Você também pode visualizar seu portal antes de publicá-lo.
O API Gateway comporta portais nos seguintes navegadores:
Firefox
Google Chrome
Microsoft Edge
Safari
Escolher um nome do domínio
Por padrão, o URL do seu portal é hospedado no seguinte nome de domínio de propriedade da Amazon:
https://p-portalId.apigw-portal.us-east-1.on.aws
Para personalizar o nome de domínio, você pode fornecer um de sua propriedade e um certificado SSL para o domínio personalizado. O certificado deve ser associado ao AWS Certificate Manager (ACM) na região do Leste dos EUA (Norte da Virgínia) e deve ser aceito no Amazon CloudFront. Para acessar informações, consulte Requisitos para usar certificados SSL/TLS com o CloudFront.
Quando você usa um nome de domínio personalizado, o API Gateway cria uma distribuição do CloudFront, protegida em trânsito com seu certificado ACM. Depois, o API Gateway fornece um registro de alias, que você vai adicionar à sua configuração DNS. O registro de alias é o nome de domínio de propriedade da Amazon. Você deve adicioná-lo para encaminhar o tráfego para a distribuição do CloudFront para seu domínio personalizado. O nome de domínio fornecido deve ser exclusivo e ainda não ter sido usado pela lista de aliases em uma distribuição existente do CloudFront.
Se você usar seu próprio nome de domínio, o API Gateway utilizará a política de segurança TLS_1_2 para proteger seu portal. Para acessar mais informações, consulte Protocolos e cifras compatíveis entre visualizadores. Você não pode alterar esse valor.
Criar um portal
Você vai usar o console do API Gateway para criar e configurar seu portal. Os procedimentos a seguir guiam você por todas as etapas necessárias. Você também pode escolher Ir para revisar e criar no final do primeiro procedimento para criar um portal vazio.
O procedimento a seguir mostra como criar um portal. Primeiro, defina os detalhes do portal.
Como definir os detalhes do seu portal
Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway
. No painel de navegação principal, selecione Portais.
Escolha Criar portal.
-
Em detalhes do portal, em Nome da política, insira um nome.
Em Descrição do portal, insira uma descrição.
Em Autorização do portal, selecione como autorizar seu portal.
-
Se essa for a primeira vez que cria um portal, recomendamos que você escolha Nenhum. Se você planeja adicionar quaisquer APIs de produção ao seu portal, utilize Exigir autorização.
-
Para exigir que os consumidores do portal se autentiquem para usar seu portal, escolha Exigir autorização e faça o seguinte:
-
Para o grupo de usuários do Amazon Cognito, selecione seu grupo de usuários.
O grupo de usuários deve estar na mesma região que seu portal.
-
Em ID do cliente da aplicação, escolha o ID do cliente da aplicação.
No seu cliente de aplicação, você deve definir o URL de retorno de chamada para o URL padrão do portal.
-
Em Domínio do grupo de usuários, insira o domínio do grupo de usuários. Para acessar mais informações, consulte Configurar um domínio do grupo de usuários.
-
-
-
Em Configuração de domínio, selecione o nome de domínio para seu portal.
-
Se essa for a primeira vez que cria um portal, recomendamos que você escolha Domínio padrão. Depois de publicar seu portal, ele estará disponível em
https://p-.portalId.apigw-portal.us-east-1.on.aws -
Para fornecer um nome de domínio personalizado de sua propriedade, selecione Nome de domínio personalizado e faça o seguinte:
-
Em Nome do domínio, insira o nome de domínio totalmente qualificado.
Em Certificado ACM, escolha um certificado ACM que abranja o nome do domínio.
Você precisará adicionar o registro de alias que o API Gateway provisiona no seu registro DNS, a fim de direcionar o tráfego do seu portal.
-
-
-
Para adicionar um monitor de aplicação CloudWatch RUM ao seu portal, em Monitor de aplicação RUM, escolha um monitor de aplicação. Para acessar mais informações, consulte CloudWatch RUM.
Escolha Next (Próximo).
Depois de definir os detalhes do seu portal, adicione produtos do portal. Você pode alterar os produtos em seu portal a qualquer momento, mas precisa publicá-lo novamente para que as alterações sejam implementadas.
Como selecionar seus produtos do portal
Na lista de recursos, selecione os produtos a serem adicionados ao seu portal.
Escolha Next (Próximo).
Depois de selecionar seus produtos, personalize o design do portal. Para fazer upload de um logotipo para o portal, você precisa ter uma imagem carregada no Amazon S3. Você pode alterar esses valores a qualquer momento, mas precisa publicar novamente o portal para que as alterações sejam implementadas.
(Opcional) Como personalizar seu portal
-
Em Logotipo do portal, forneça o URI do S3 para seu arquivo.
Somente
.svg,.pngou.jpgsão aceitos. -
Para personalizar o design do portal, você tem duas opções:
Você pode escolher o tema do portal para aplicar um tema de cores predefinido ao seu portal.
Você pode utilizar os seletores de cores para selecionar todas as opções do design do seu portal.
-
Escolha Next (Próximo).
Depois de selecionar o design, revise as informações do portal.
Como revisar o portal
-
Revise as configurações na página de análise e criação. Quando estiver satisfeito com as configurações, clique em Criar.
Se você usar um grupo de usuários do Amazon Cognito para controlar o acesso ao portal, deverá definir o URL de retorno de chamada como o URL padrão do portal no cliente da aplicação. Para acessar mais informações, consulte Configurações específicas da aplicação com clientes da aplicação.
Seu portal não estará disponível para os consumidores depois que você o criar. Você deve publicá-lo para ele ficar acessível na internet. Para obter mais informações, consulte Publicar um portal no API Gateway.
