Configurar chaves de API para a API REST no API Gateway - Amazon API Gateway
Exigir uma chave de API em um métodoCriar uma chave de APIImportar chaves de API

Configurar chaves de API para a API REST no 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 Desenvolver APIs REST no API Gateway e Implantar APIs REST no API Gateway, respectivamente.

Depois de criar uma chave de API, você deve associá-la a um plano de uso. Para obter mais informações, consulte Configurar planos de uso para APIs REST no 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.

AWS Management Console
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.

    Adicionar uma chave de API a um método

  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.

AWS CLI

O comando put-method indicado abaixo cria um método PUT que exige uma chave de API:

aws apigateway put-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --authorization-type "NONE" \
    --api-key-required

O comando update-method indicado abaixo atualiza um método existente para exigir uma chave de API:

aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"
REST API

Para exigir uma chave de API em um método, siga um destes procedimentos:

  • Chame method:put para criar um método. Defina apiKeyRequired como true na carga da solicitação.

  • Chame method:update para definir apiKeyRequired como true.

Criar uma chave de API

O procedimento a seguir mostra como criar uma chave de API. Se você quiser importar a chave de API, ignore esta etapa.

AWS Management Console
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.

    Criar chaves de API para planos de uso

  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.

AWS CLI

O comando create-api-key indicado abaixo cria uma chave de API:

 aws apigateway create-api-key \
    --name 'Dev API key' \
    --description 'API key for Devs' \
    --enabled
REST API

Chame apikey:create para criar uma chave de API.

Importar chaves de API

O procedimento a seguir descreve como importar chaves de API. Se você já tiver criado uma chave de API, ignore esta etapa.

AWS Management Console
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.

AWS CLI

O comando import-api-keys indicado abaixo importa uma chave de API:

aws apigateway import-api-key \
    a--body fileb://keys.csv \
    --format csv
REST API

Chame apikey:import para importar uma chave de API de um arquivo. Para saber o formato de arquivo, consulte Formato de arquivo da chave de API do API Gateway.

Não é possível alterar o valor da nova chave de API. Depois de criar a API, configure um plano de uso. Para obter mais informações, consulte Configurar planos de uso para APIs REST no API Gateway.