Route - Post Route Matrix

Use para obter uma matriz de rota mostrando o tempo de viagem e a distância para todos os pares possíveis em uma lista de origens e destinos, usando uma solicitação assíncrona.

A API Post Route Matrix é uma solicitação de POST HTTP que permite o cálculo de uma matriz de resumos de rota para um conjunto de rotas definidas por locais de origem e destino usando uma solicitação assíncrona (assíncrona). Para fazer uma solicitação síncrona (sincronização), consulte Post Route Matrix Sync. Para cada origem, o serviço calcula o custo do encaminhamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como os cabeçalhos de coluna e linha de uma tabela e cada célula na tabela contém os custos de roteamento da origem para o destino dessa célula. Como exemplo, digamos que uma empresa de entrega de comida tenha 20 motoristas e eles precisem encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API de Rota de Matriz.

Para cada rota, os tempos de viagem e distâncias são devolvidos. Você pode usar os custos calculados para determinar quais rotas detalhadas calcular usando a API de Direções de Rota.

O tamanho máximo de uma matriz para solicitação assíncrona é 700 e para solicitação de sincronização é de 100 (o número de origens multiplicado pelo número de destinos).

Enviar solicitação de matriz de rota síncrona

Se o seu cenário exigir solicitações síncronas e o tamanho máximo da matriz for menor ou igual a 100, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 100 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 10x10, 6x8, 9x8 (não precisa ser quadrado).

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar solicitação de matriz de rota assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de roteamento relativamente complexas. Quando você faz uma solicitação usando uma solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho da resposta. Este URL deve ser verificado periodicamente até que os dados de resposta ou informações de erro estejam disponíveis. Se waitForResults parâmetro na solicitação estiver definido como true, o usuário obterá uma resposta 200 se a solicitação for concluída em menos de 120 segundos.

O tamanho máximo de uma matriz para esta API é 700 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões matriciais possíveis são: 50x10, 10x10, 28x25. 10x70 (não precisa ser quadrado).

As respostas assíncronas são armazenadas por 24 horas. O URL de redirecionamento retorna uma resposta 404 se usado após o período de expiração.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

Aqui está uma sequência típica de operações assíncronas:

1. O cliente envia uma solicitação POST da Matriz de Rota para o Azure Maps

2. O servidor responderá com uma das seguintes opções:

   HTTP 202 Accepted - A solicitação de matriz de rota foi aceita.

   HTTP Error - Ocorreu um erro ao processar o seu pedido de Route Matrix. Isso pode ser uma solicitação incorreta 400 ou qualquer outro código de status de erro.

3. Se a solicitação de Rota de Matriz foi aceita com êxito, o cabeçalho Location na resposta contém a URL para baixar os resultados da solicitação. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

4. O cliente emite uma solicitação GET no URL de download obtido na Etapa 3 para baixar os resultados

Baixar resultados de sincronização

Quando você faz uma solicitação POST para a API de sincronização da matriz de rota, o serviço retorna 200 código de resposta para solicitação bem-sucedida e uma matriz de resposta. O corpo da resposta conterá os dados e não haverá possibilidade de recuperar os resultados mais tarde.

Baixar resultados assíncronos

Quando uma solicitação emite uma resposta 202 Accepted, a solicitação está sendo processada usando nosso pipeline assíncrono. Você receberá uma URL para verificar o progresso da sua solicitação assíncrona no cabeçalho do local da resposta. Esse URI de status tem a seguinte aparência:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

O URL fornecido pelo cabeçalho do local retornará as seguintes respostas quando uma solicitação de GET for emitida.

HTTP 202 Accepted - A solicitação de matriz foi aceita, mas ainda está sendo processada. Por favor, tente novamente dentro de algum tempo.

HTTP 200 OK - Pedido de matriz processado com sucesso. O corpo da resposta contém todos os resultados.

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

AADToken

Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observações

• Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

• Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully submit a route matrix request

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

operation-Location: New URL to check the status of the long-running operation.

Definições

ComputeTravelTime

Especifica se os tempos de viagem adicionais devem ser devolvidos usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem padrão com melhor estimativa.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

GeoJsonMultiPoint

Um tipo de geometria GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.

InclineLevel

Grau de acidez para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com routeType=thrilling.

JsonFormat

Formato desejado da resposta. Apenas json formato é suportado.

RouteAvoidType

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em um pedido, por exemplo, '&evita=autoestradas&evita=pedágioEstradas&evitar=ferries'. Em solicitações de intervalo de rotas, o valor alreadyUsedRoads não deve ser usado.

RouteLegSummary

Objeto de resumo para a seção de rota.

RouteMatrix

Objeto de resultado da matriz

RouteMatrixQuery

Um objeto com uma matriz de coordenadas.

RouteMatrixResult

Este objeto é retornado de uma chamada Route Matrix bem-sucedida. Por exemplo, se forem fornecidas 2 origens e 3 destinos, haverá 2 matrizes com 3 elementos em cada. O conteúdo de cada elemento depende das opções fornecidas na consulta.

RouteMatrixResultResponse

Objeto de resposta da célula atual na matriz de entrada.

RouteMatrixSummary

Objeto de resumo

RouteType

O tipo de rota solicitada.

SectionType

Especifica qual dos tipos de seção é relatado na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em um pedido, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O padrão sectionType refere-se à entrada travelMode. Por padrão, travelMode está definido como carro

TravelMode

O modo de viagem para a rota solicitada. Se não estiver definido, o padrão é 'carro'. Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta para essa seção será "outro". Observe que os modos de viagem ônibus, motocicleta, táxi e van são funcionalidades BETA. Os dados completos de restrição não estão disponíveis em todas as áreas.

VehicleLoadType

Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores de vehicleLoadType disponíveis são classes 1 a 9 do US Hazmat, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, este parâmetro só é considerado para travelMode=truck.

WindingnessLevel

Nível de voltas para uma rota emocionante. Este parâmetro só pode ser usado em conjunto com routeType=thrilling.