Visão geral da API Routes

A API Routes é um serviço que aceita uma solicitação HTTPS e retorna a rota ideal entre dois locais ou as distâncias e os tempos de viagem de uma matriz de rotas entre diferentes locais de origem e destino.

Por que usar a API Routes

Com a API Routes, você pode receber informações precisas sobre rotas e viagens usando detalhes de transporte, condições atualizadas de trânsito e vias e preferências de rota:

  • Tipo e recursos de diferentes meios de transporte

  • Qual direção um veículo está seguindo

  • O lado da via para embarques ou desembarques

  • Condições de trânsito e interdições

  • Questões de segurança, como evitar áreas perigosas ou fornecer áreas de retirada seguras

  • Equilibre a latência, a qualidade e o custo em todas as suas necessidades de roteamento com recursos opcionais, como pedágios e metadados de viagem, como tempo e distância, e eficiência de combustível.

Também é possível determinar as rotas mais eficientes para a programação de envio, como:

  • A melhor forma de atribuir um conjunto de workers para retirar uma série de pacotes

  • Determinar o melhor depósito para enviar pacotes ao destino final

O que você pode fazer com a API Routes?

Com a API Routes, você pode receber duas categorias principais de informações de roteamento:

  • Roteiros de um local para um ou vários destinos

  • Uma matriz de rotas possíveis entre muitos locais de início e término.

Receber rotas para um ou vários destinos

Com o método Compute Routes da API Routes, é possível calcular entre locais:

  • Confira rotas para diferentes formas de viajar e para um ou mais destinos:

    • Modos de transporte, incluindo transporte público, direção, veículos de duas rodas, caminhada ou bicicleta.

    • Uma série de pontos de passagem que podem ser otimizados para a ordem mais eficiente de viagem.

  • Várias maneiras de especificar origens, destinos e pontos de referência:

    • Strings de texto. Por exemplo: "Chicago, IL", "Darwin, NT, Australia", "1800 Amphitheatre Parkway, Mountain View, CA 94043" ou "CWF6+FWX Mountain View, California"

    • IDs de lugares

    • Coordenadas de latitude e longitude, opcionalmente com a direção do veículo

  • Ajuste as opções de rota com base nas suas necessidades e objetivos:

  • Controle a latência e a qualidade solicitando apenas os dados necessários usando uma máscara de campo, que ajuda a evitar tempo de processamento desnecessário e taxas de faturamento mais altas. Para mais detalhes, consulte Escolher quais informações retornar.

Acessar uma matriz de rotas possíveis

O método Compute Route Matrix da API Routes fornece uma matriz de informações sobre rotas recomendadas entre vários pontos de partida e chegada, incluindo distância e horários de chegada estimados, para ajudar você a escolher as melhores origens e destinos com base nas suas necessidades de negócios. Você pode solicitar estes tipos de dados de distância:

  • Distância para um modo de transporte selecionado

  • Distância em quilômetros ou milhas

  • Tempo estimado de viagem no trânsito

Com os dados de distância, você pode determinar a maneira mais eficiente de rotear passageiros, remessas ou trabalhadores entre várias origens e destinos possíveis.

É possível transmitir elementos da resposta antes que a matriz inteira seja calculada, reduzindo a latência da resposta.

É possível especificar várias origens e destinos por solicitação do lado do servidor com o número de origens vezes o número de destinos até 625.

Como a API Routes funciona

A API Routes tem dois métodos: ComputeRoutes e ComputeRouteMatrix.

ComputeRoutes

O método ComputeRoutes da API Routes aceita uma solicitação POST HTTP com um corpo de solicitação JSON que contém os detalhes da solicitação. São necessários uma origem, um destino, um modo de transporte e uma máscara de campo para especificar quais campos serão retornados.

Exemplo

curl -X POST -d '{
    "origin": {
      "address": "1800 Amphitheatre Parkway, Mountain View, CA 94043"
    },
    "destination": {
      "address": "Sloat Blvd &, Upper Great Hwy, San Francisco, CA 94132"
    },
  "travelMode": "DRIVE"
  }' \
  -H 'Content-Type: application/json' -H 'X-Goog-Api-Key: YOUR_API_KEY' \
  -H 'X-Goog-FieldMask: routes.duration,routes.distanceMeters' \
  'https://routes.googleapis.com/directions/v2:computeRoutes'

Em seguida, o serviço calcula a rota solicitada e retorna os campos que você solicitou.

ComputeRouteMatrix

A API Routes ComputeRouteMatrix aceita uma solicitação POST HTTP com um corpo de solicitação JSON que contém os detalhes da solicitação. É necessário ter pelo menos uma origem, dois ou mais destinos, o travelMode e uma máscara de campo para especificar quais campos serão retornados.

Exemplo

curl -X POST -d '{
  "origins": [
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.420761,
            "longitude": -122.081356
          }
        }
      }
    },
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.403184,
            "longitude": -122.097371
          }
        }
      }
    }
  ],
  "destinations": [
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.420999,
            "longitude": -122.086894
          }
        }
      }
    },
    {
      "waypoint": {
        "location": {
          "latLng": {
            "latitude": 37.383047,
            "longitude": -122.044651
          }
        }
      }
    }
  ],
  "travelMode": "DRIVE"
}' \
-H 'Content-Type: application/json' -H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H 'X-Goog-FieldMask: originIndex,destinationIndex,duration,distanceMeters,status,condition' \
'https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix'

A resposta contém as rotas possíveis para a combinação de todos os pontos de referência de origem e destino.

Recursos

A tabela a seguir resume os recursos disponíveis na API Routes e os dados retornados.

Recursos de dados Dados retornados Formato da devolução
ComputeRoutes Retorna rotas, segmentos e etapas de uma rota, com rotas alternativas, se solicitado. JSON
ComputeRouteMatrix Retorna uma matriz de rotas de um ponto de passagem de origem para um ponto de passagem de destino.

Como usar a API Routes

1 Configurar Comece com Configurar seu projeto do Google Cloud e siga as instruções de configuração.
2 Calcular um trajeto e analisar a resposta Para mais informações, consulte Receber uma rota e Analisar as respostas de rota.
3 Calcular a matriz de rotas e analisar a resposta Para mais informações, consulte Acessar uma matriz de rotas e Analisar a resposta da matriz de rotas.

Bibliotecas de clientes disponíveis

Para conferir uma lista das bibliotecas de cliente disponíveis para a API Routes, consulte Bibliotecas de cliente.

A seguir