Configurar chaves de API usando a API REST 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 as chamadas da API REST de criação e implantação de uma API, consulte restapi:create e deployment:create, respectivamente.

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

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 ou importar chaves de API

Para criar ou importar uma chave de API, siga um destes procedimentos:

• Chame apikey:create para criar uma chave de 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. Para saber mais sobre como configurar um plano de uso, consulte Criar, configurar e testar planos de uso com a API REST e a CLI do API Gateway.