Portais do API Gateway

É possível utilizar um portal do API Gateway para compartilhar suas APIs e a respectiva documentação com consumidores de API em uma página da Web. Um portal contém um conjunto de produtos do portal. Cada produto do portal é um agrupamento lógico de APIs REST e contém a documentação que você cria e publica para seus consumidores de API. As páginas do produto em um portal contêm a documentação personalizada em nível de produto do portal. As páginas de endpoint REST do produto contêm a documentação de cada uma das APIs REST, bem como o caminho, o método e o estágio de uma API REST. A combinação de páginas de produtos e páginas de endpoint REST de produtos fornece a documentação completa para permitir que os consumidores de API aprendam como começar a utilizar suas APIs REST.

Utilize um portal para fazer o seguinte:

• Use o API Gateway em todo o ciclo de vida das APIs, desde a criação até a documentação e a distribuição delas.

• Compartilhe produtos do portal em todas contas da AWS.

• Personalize e compartilhe um local central para seus produtos do portal e forneça páginas de produtos.

Considerações

As considerações a seguir podem afetar o uso de portais do API Gateway:

• Você só pode criar portais para compartilhar APIs REST.

• Os portais são criados em nível de região da AWS. Seu portal só pode conter APIs REST que estejam na mesma região onde você cria o portal.

• Você só pode usar o Console de gerenciamento da AWS, a AWS CLI ou AWS SDKs para criar e compartilhar seus portais.

• Você só pode controlar o acesso ao seu portal utilizando grupos de usuários do Amazon Cognito. Os consumidores do seu portal podem fazer login diretamente por meio de um grupo de usuários ou federar por meio de um provedor de identidades (IdP) de terceiros. Se você usa um grupo de usuários do Amazon Cognito, não pode definir um segredo de cliente para ele. Para acessar mais informações, consulte Grupos de usuários do Amazon Cognito.