Usar OAuth

A API Route Optimization permite o uso do OAuth 2.0 para autenticação. O Google oferece suporte a cenários comuns do OAuth 2.0, como os de um servidor da Web.

Este documento descreve como transmitir um token OAuth para a chamada da API Route Optimization no seu development. 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 começar a usar a API Route Optimization, você precisa de uma projeto com uma conta de faturamento e a API Route Optimization ativada. Recomendamos criar várias Proprietários de projetos e administradores de faturamento, para que sempre tenha alguém com essas funções disponíveis para sua equipe. Para saber mais, consulte Configurar no console do Cloud.

Sobre o OAuth

Há muitas maneiras de criar e gerenciar tokens de acesso com o OAuth com base na sua implantação de nuvem.

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

Você também pode usar a API Route Optimization como parte de um app para dispositivos móveis Android ou iOS. Para informações gerais sobre como usar o OAuth com a API Route Optimization, inclusive sobre como gerenciar de acesso a 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 Route Optimization, é necessário atribuir o escopo ao token OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Exemplo: teste chamadas da API REST no ambiente de desenvolvimento local

Se você quiser testar a API Route Optimization usando um token OAuth, mas não tiver um ambiente 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 usando bibliotecas de cliente, consulte Faça a autenticação 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 na Configuração no console do Google Cloud
  2. Instale e inicialize a CLI gcloud.

  3. Execute o seguinte comando gcloud na sua máquina local para criar o arquivo de credencial:

    gcloud auth application-default login
  4. Uma tela de login será exibida. Após o login, suas credenciais são armazenadas no arquivo de credencial local usado pelo ADC.

Para mais informações, consulte Ambiente de desenvolvimento local do Fornecer credenciais para o Application Default Credentials na documentação do Google Cloud.

Faça uma solicitação REST

Neste exemplo, você passa dois cabeçalhos de solicitação:

  • Transmita o token OAuth no cabeçalho Authorization usando o código abaixo. 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.

  • Especifique o tipo de conteúdo do corpo da solicitação como application/json.

O exemplo a seguir faz uma chamada para a API Route Optimization usando um token OAuth:

curl -X POST 'https://routeoptimization.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID:optimizeTours' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
--data-binary @- << EOM
{
  "model": {
    "shipments": [
      {
        "pickups": [
          {
            "arrivalLocation": {
              "latitude": 37.73881799999999,
              "longitude": -122.4161
            }
          }
        ],
        "deliveries": [
          {
            "arrivalLocation": {
              "latitude": 37.79581,
              "longitude": -122.4218856
            }
          }
        ]
      }
    ],
    "vehicles": [
      {
        "startLocation": {
          "latitude": 37.73881799999999,
          "longitude": -122.4161
        },
        "endLocation": {
          "latitude": 37.73881799999999,
          "longitude": -122.4161
        }
      }
    ],
    "globalStartTime": "2023-01-13T16:00:00-08:00",
    "globalEndTime": "2023-01-14T16:00:00-08:00"
  }
}
EOM

Solução de problemas

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