Configurar chaves da API usando o console do API Gateway

Para configurar as chaves de API, faça o seguinte:

• Configure métodos de API para exigir uma chave de API.

• Crie ou importe uma chave de API para a API em uma região.

Antes de configurar chaves de API, é necessário ter criado a API e tê-la implantado em uma etapa. Depois que um valor de chave de API for atribuído, ele não poderá ser alterado.

Para obter instruções sobre como criar e implantar uma API usando o console do API Gateway, consulte Criação de uma API REST no Amazon API Gateway e Implantar uma API REST no Amazon API Gateway, respectivamente.

Depois de criar uma chave de API, você deve associá-la a um plano de uso. Para ter mais informações, consulte Criar, configurar e testar planos de uso com o console do API Gateway.

nota

Para ver as práticas recomendadas a serem consideradas, consulte Práticas Recomendadas para chaves de API e planos de uso.

Exigir uma chave de API em um método

O procedimento a seguir descreve como configurar um método de API para exigir uma chave de API.

Para configurar um método de API para exigir uma chave de API

1. Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. Escolha uma API REST.

3. No painel de navegação principal do API Gateway, escolha Resources (Recursos).

4. Em Resources (Recursos), crie um novo método ou escolha um existente.

5. Na guia Solicitação de método, em Configurações de solicitação de método, escolha Editar.

   

6. Selecione a Chave de API obrigatória.

7. Escolha Salvar.

8. Implante ou reimplante a API para que o requisito entre em vigor.

Se a opção Chave de API obrigatória estiver definida como false e você não executar as etapas anteriores, nenhuma chave de API associada a um estágio de API será usada para o método.

Criar uma chave de API

Se você já tiver criado ou importado chaves de API para uso com planos de uso, poderá ignorar este procedimento e avançar para o seguinte.

Para criar uma chave de API

1. Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. Escolha uma API REST.

3. No painel de navegação principal do API Gateway, escolha Chaves de API.

4. Escolha Criar chave de API.

   

5. Em Nome, insira um nome.

6. (Opcional) Em Description (Descrição), insira uma descrição.

7. Em Chave de API, escolha Gerar automaticamente para que o API Gateway gere o valor da chave ou escolha Personalizado para criar seu próprio valor de chave.

8. Escolha Salvar.

Importar chaves de API

O procedimento a seguir descreve como importar chaves de API para utilização com planos de uso.

Para importar chaves de API

1. Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. Escolha uma API REST.

3. No painel de navegação principal, selecione Chaves de API.

4. Selecione o menu suspenso Ações e Importar chaves de API.

5. Para carregar um arquivo de chave separado por vírgula, selecione Escolher arquivo. Você também pode inserir as chaves no editor de texto. Para obter informações sobre o formato do arquivo, consulte Formato de arquivo da chave de API do API Gateway.

6. Escolha Falhar nos avisos para interromper a importação em caso de erro ou escolha Ignorar avisos para continuar a importar entradas de chave válidas quando houver um erro.

7. Escolha Importar para importar as chaves de API.