Route - Post Route Matrix Async

A API Route Matrix Async é uma solicitação HTTP POST que permite o cálculo de uma matriz de resumos de rotas para um conjunto de rotas definidas por locais de origem e destino usando uma solicitação assíncrona (assíncrona). Para cada origem determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. O conjunto de origens e o conjunto de destinos podem ser considerados como 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. Matrizes de rota podem ser calculadas para rotas de condução, caminhada e caminhão.

Matrizes de rota são usadas em vários tipos diferentes de aplicativos, mais comumente para resolver o PROBLEMA do Vendedor Viajante (TSP) e o VRP (Problema de Roteamento de Veículo). Para cada par de origem-destino na matriz, o tempo de viagem e a distância são retornados. Você pode usar os custos computados 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 é 50000 (o número de origens multiplicado pelo número de destinos).

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 solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL no campo operation-Location do cabeçalho de resposta com o ponto de extremidade de geografia do Azure Mapas '{geography}.atlas.microsoft.com. Essa URL deve ser verificada periodicamente até que o status seja bem-sucedido.

O tamanho máximo de uma matriz para essa API é 50000 (o número de origens multiplicado pelo número de destinos). Com essa restrição em mente, exemplos de dimensões de matriz possíveis são: 500x100, 100x100, 280x170. 100 x 50 (não precisa ser quadrado).

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

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

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

1. O cliente envia uma solicitação POST de Matriz de Rotas para o Azure Mapas

2. O servidor responderá com um dos seguintes:

   HTTP 202 Accepted – A solicitação de Matriz de Rota foi aceita.

   HTTP Error - Houve um erro ao processar sua solicitação de Matriz de Rotas. Pode ser uma solicitação 400 incorreta ou qualquer outro código de status de erro.

3. Se a solicitação Matrix Route foi aceita com êxito, o cabeçalho operation-location na resposta contém a URL para obter o status da solicitação. Esse URI de status é semelhante ao seguinte:

  GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01?subscription-key={subscription-key}

4. O cliente emite uma solicitação GET no resultadoUrl obtido na Etapa 3 para obter os resultados

  GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01?subscription-key={subscription-key}

Limitações da API

O processamento assíncrono da matriz é mais adequado para matrizes maiores que exigem cálculo de rota pesada. A limitação a seguir é aplicável às solicitações assíncronas. Se nenhuma das linhas na tabela a seguir corresponder aos parâmetros da solicitação, a solicitação não atenderá aos requisitos e não será processada.

POST https://atlas.microsoft.com/route/matrix:async?api-version=2025-01-01

Parâmetros de URI

Cabeçalho da solicitação

Media Types: "application/geo+json"

Corpo da solicitação

Media Types: "application/geo+json"

Respostas

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.

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

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

Escopos

subscription-key

Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 protegida 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 de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Submit an asynchronous request for matrix

POST https://atlas.microsoft.com/route/matrix:async?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            9.15049,
            45.458545
          ],
          [
            11.050541,
            45.403337
          ]
        ]
      },
      "properties": {
        "pointType": "origins"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            11.499931,
            48.149853
          ],
          [
            14.538226,
            50.033688
          ]
        ]
      },
      "properties": {
        "pointType": "destinations"
      }
    }
  ],
  "departAt": "2022-12-19T16:39:57+01:00",
  "optimizeRoute": "fastest",
  "traffic": "historical",
  "travelMode": "truck",
  "avoid": [
    "unpavedRoads"
  ]
}

Operation-Location: https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557?api-version=2025-01-01

Definições

AdrTunnelRestrictionCodeEnum

O código de restrição do túnel ADR. A ADR é um acordo europeu relativo ao transporte internacional de mercadorias perigosas por estrada. O código de restrição do túnel ADR é usado para determinar se um veículo tem permissão para passar por um túnel com restrições no transporte de mercadorias perigosas.

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é o Recurso. Para obter mais informações, consulte RFC 7946.

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto com suporte é FeatureCollection. Para obter mais informações, consulte RFC 7946.

GeoJsonMultiPoint

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

InputRouteMatrixFeaturesItem

Especifica a origem de entrada e os pontos de destino e propriedades adicionais para o objeto de recurso GeoJSON MultiPoint. Consulte RFC 7946 para obter detalhes.

InputRouteMatrixProperties

Especifica o objeto properties para a matriz de entrada.

MapsErrorDetail

O detalhe do erro.

MapsErrorResponse

Resposta de erro comum para AS APIs do Azure Mapas retornarem detalhes de erro para operações com falha.

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

RouteMatrixAsyncOptimizeRouteEnum

Especifica o parâmetro a ser usado para otimizar a rota. Se não for definido, o padrão será "mais rápido" que retorna a rota para minimizar o tempo de viagem.

Exemplo: "optimizeRoute":"shortest"

RouteMatrixAsyncRequest

Use para obter uma matriz de rotas mostrando o tempo de viagem e a distância para todos os pares possíveis em uma lista de origens e destino. GeoJSON objeto de recurso e propriedades adicionais. Consulte RFC 7946 para obter detalhes.

RouteMatrixAvoidEnum

Especifica as restrições que o cálculo de rota deve respeitar ao determinar a rota. Evite dar suporte a vários valores em uma solicitação e só tem suporte para a condução e o caminhão travelMode.

RouteMatrixTrafficEnum

Especifica como o tráfego é considerado para rotas de computação.

Valor padrão: historical

RouteMatrixTravelModeEnum

Especifica o perfil de viagem a ser considerado ao calcular a matriz. Se não for especificado, o valor padrão será "condução".

Exemplo: "travelMode":"driving"

RouteMatrixTypeEnum

Especifica o tipo multiPoint de origem e o tipo multipoint de destino para a matriz de entrada.

RouteMatrixVehicleSpec

Especifica os atributos do veículo, como altura do veículo, peso, velocidade máxima, tipo de carga etc. a serem considerados ao calcular a matriz de rotas. Isso ajuda a evitar desembaraços de pontes baixas, restrições de estrada, curvas à direita difíceis para fornecer a rota otimizada com base nas especificações do veículo. Os atributos do veículo são especificados na propriedade vehicleSpec.

VehicleLoadTypeEnum

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países. vehicleLoadType dá suporte a vários valores em uma solicitação.