Route - Post Route Matrix Async

A API Route Matrix Async é 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 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. As matrizes de rota podem ser calculadas para rotas de condução, caminhada e caminhão.

As Matrizes de Rota são usadas em vários tipos diferentes de aplicações, mais comumente para resolver o Problema do Caixeiro Viajante (TSP) e o Problema de Roteamento de Veículos (VRP). Para cada par origem-destino na matriz, o tempo de viagem e a distância 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 é 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 uma 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 Maps '{geography}.atlas.microsoft.com. Esse URL deve ser verificado periodicamente até que o status seja Bem-sucedido.

O tamanho máximo de uma matriz para esta API é 50000 (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: 500x100, 100x100, 280x170. 100x50 (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: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 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 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 tem a seguinte aparência:

  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 resultUrl 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 pesado. A limitação a seguir é aplicável às solicitações assíncronas. Se nenhuma das linhas da 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 do URI

Cabeçalho do Pedido

Media Types: "application/geo+json"

Corpo do Pedido

Media Types: "application/geo+json"

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.

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

Âmbitos

subscription-key

Essa é uma chave compartilhada que é provisionada ao criar um 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 essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.

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

Tipo: apiKey
Em: header

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

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. O ADR é um acordo europeu relativo ao transporte rodoviário internacional de mercadorias perigosas. O código de restrição do túnel ADR é utilizado para determinar se um veículo pode atravessar um túnel com restrições ao transporte de mercadorias perigosas.

FeaturesItemTypeEnum

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

FeatureTypeEnum

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

GeoJsonMultiPoint

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

InputRouteMatrixFeaturesItem

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

InputRouteMatrixProperties

Especifica o objeto de propriedades para a matriz de entrada.

MapsErrorDetail

O detalhe do erro.

MapsErrorResponse

Resposta de erro comum para APIs do Azure Maps para retornar 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 é "mais rápido", que retorna a rota para minimizar o tempo de viagem.

Exemplo: "optimizeRoute":"shortest"

RouteMatrixAsyncRequest

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 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. Avoid suporta vários valores em uma solicitação e só é suportado para o modo de condução e viagem do caminhão.

RouteMatrixTrafficEnum

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

Valor predefinido: historical

RouteMatrixTravelModeEnum

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

Exemplo: "travelMode":"driving"

RouteMatrixTypeEnum

Especifica o tipo MultiPoint de origem e o tipo de 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 rota. Isso ajuda a evitar baixas folgas de pontes, restrições de estrada, curvas difíceis à direita 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 classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores disponíveis de vehicleLoadType são as classes 1 a 9 do Hazmat dos EUA, 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 otherHazmat deve ser usado para todos os outros países. vehicleLoadType suporta vários valores em uma solicitação.