Como usar chaves de API

Esta página descreve como usar chaves de API no API Gateway.

Uma chave de API é uma string criptografada simples que identifica um projeto do Google Cloud para fins de cota, faturamento e monitoramento. Um desenvolvedor gera uma chave de API em um projeto no console do Google Cloud e a incorpora em todas as chamadas para a API como um parâmetro de consulta ou em um cabeçalho de solicitação.

Se você especificar um requisito de chave de API na configuração da API, o API Gateway vai usar a chave de API para procurar o projeto do Google Cloud associado. O ESP rejeitará solicitações, a menos que a chave de API tenha sido gerada no seu projeto do Google Cloud ou em outros projetos em que a API foi ativada.

Observação: ao contrário das credenciais que usam tokens de curta duração ou solicitações assinadas, as chaves de API funcionam como parte da solicitação de API. Como resultado, as chaves de API são vulneráveis a ataques intermediários e podem não ser tão seguras quanto outras credenciais de autenticação. É possível usar chaves de API além de uma das outras formas de autenticação com suporte, mas não recomendamos usar apenas chaves de API quando as chamadas de API contêm dados sensíveis.

Para criar uma chave de API ou conferir as chaves já disponíveis no seu projeto do Google Cloud, acesse a página APIs e serviços > Credenciais.

Ir para Credenciais

Caso de uso

Para usar recursos do gateway de API, como cotas, é possível passar uma chave de API para que o gateway de API possa identificar o projeto do Google Cloud ao qual o aplicativo cliente está associado.

Sobre a autenticação de chave de API para o gateway de API

Se você estiver usando uma chave de API para autenticação, primeiro ative o suporte à chave de API no seu serviço.

Digite este comando:

gcloud services enable MANAGED_SERVICE_NAME

O MANAGED_SERVICE_NAME especifica o nome do serviço gerenciado criado quando você implantou a API. Esse nome está na coluna "Serviço gerenciado" da API na página de destino das APIs no console. Outra opção é encontrar esse nome na propriedade Managed service ao usar o comando gcloud api-gateway apis describe.

Exemplo:

gcloud services enable my-api-a12bcd345e67f89g0h.apigateway.my-project.cloud.goog

Como restringir chaves de API

As chaves de API são irrestritas por padrão. As chaves irrestritas não são seguras porque podem ser usadas por qualquer pessoa e de qualquer lugar. Recomendamos que você adicione restrições de API sempre que possível. Essas restrições especificam quais APIs podem ser chamadas com a chave de API. Todas as chaves de API usadas por aplicativos de produção devem ter restrições de API.

Para adicionar restrições de API:

1. Encontre o título da API, conforme observado na configuração da API. No exemplo abaixo, o título da API é My Example Config:

   # openapi.yaml
   swagger: '2.0'
   info:
     title: My Example Config
     description: Sample API on API Gateway
     version: 1.0.0
   ...

2. No console do Google Cloud, acesse a página APIs e serviços > Credenciais.

   Ir para Credenciais

3. Selecione o nome da chave de API que você quer usar.

4. Na seção Restrições de API da página de detalhes da chave de API, clique em Restringir chave.

5. Selecione a API que sua chave de API vai usar para acessar na lista suspensa de APIs disponíveis. Por exemplo, se usar a configuração de exemplo acima, selecione My Example Config.

6. Clique em Salvar.

Sua restrição vai entrar em vigor em alguns instantes.