Usar OAuth

A API Map Management é compatível com o uso do OAuth 2.0 para autenticação. O Google é compatível com cenários comuns do OAuth 2.0, como os de um servidor da Web.

Neste documento, descrevemos como transmitir um token OAuth para a chamada de API Map Management no seu ambiente de desenvolvimento. Para instruções sobre como usar o OAuth em um ambiente de produção, consulte Autenticação no Google.

Antes de começar

Antes de usar a API Map Management, você precisa de um projeto com uma conta de faturamento e a API Map Management ativada. Para mais informações, consulte Configurar no console do Cloud.

Sobre o OAuth

É possível criar e gerenciar tokens de acesso com o OAuth de várias maneiras, dependendo do ambiente de implantação.

Por exemplo, o sistema OAuth 2.0 do Google aceita interações de servidor para servidor, como as que ocorrem entre seu aplicativo e um serviço do Google. Para esse cenário, você precisa de uma conta de serviço. Essa conta pertence ao seu aplicativo, e não a um usuário individual. O aplicativo chama as APIs do Google em nome da conta de serviço porque os usuários não estão diretamente envolvidos. Para mais informações sobre métodos de autenticação, consulte Autenticação no Google.

Como alternativa, é possível usar a API Map Management como parte de um app para dispositivos móveis Android ou iOS. Para mais informações sobre como usar o OAuth com a API Map Management, incluindo informações sobre como gerenciar tokens de acesso para diferentes ambientes de implantação, consulte Como usar o OAuth 2.0 para acessar as APIs do Google.

Sobre os escopos do OAuth

Para usar o OAuth com a API Map Management, o token OAuth precisa ter o escopo https://www.googleapis.com/auth/cloud-platform.

Testar chamadas de API REST no ambiente de desenvolvimento local

Se você quiser testar a API Map Management usando um token OAuth, mas não tiver um ambiente configurado para gerar tokens, use o procedimento nesta seção para fazer a chamada.

Este exemplo descreve como usar o token OAuth fornecido pelo Application Default Credentials (ADC) para fazer a chamada. Para mais informações sobre como usar o ADC para chamar APIs do Google com bibliotecas de cliente, consulte Autenticar usando bibliotecas de cliente.

Pré-requisitos

Antes de fazer uma solicitação REST usando o ADC, use a CLI do Google Cloud para fornecer credenciais ao ADC:

  1. Se ainda não tiver feito isso, crie um projeto e ative o faturamento seguindo as etapas em Configurar no console do Cloud.
  2. Instale e inicialize a CLI gcloud.

  3. Para criar o arquivo de credenciais, execute o comando gcloud na máquina local:

    gcloud auth application-default login
  4. Quando solicitado, faça login. Após o login, suas credenciais são armazenadas no arquivo de credenciais local usado pelo ADC.

Para mais informações, consulte a seção Ambiente de desenvolvimento local da documentação Fornecer credenciais para o Application Default Credentials.

Fazer uma solicitação REST

Neste exemplo, você transmite dois cabeçalhos da solicitação:

  • Transmita o token OAuth no cabeçalho Authorization usando o seguinte comando para gerar o token:

    gcloud auth application-default print-access-token

    O token retornado tem um escopo de https://www.googleapis.com/auth/cloud-platform.

  • Transmita o ID ou o nome do projeto do Google Cloud com o faturamento ativado no cabeçalho X-Goog-User-Project. Para saber mais, consulte Configurar no console do Cloud.

Faça uma chamada para a API Map Management usando um token OAuth:

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
https://mapmanagement.googleapis.com/v2beta/projects/PROJECT_NUMBER_OR_ID/mapConfigs/

Solução de problemas

Se a solicitação retornar uma mensagem de erro informando que as credenciais do usuário não são compatíveis com essa API, consulte As credenciais do usuário não estão funcionando.