Route - Post Route Matrix

A API Route Matrix é 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 de sincronização. 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. Por exemplo, uma empresa de entrega de comida tem 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega no restaurante. Para resolver esse caso de uso, eles podem chamar a API da Matriz de Rotas e usar o custo da viagem para classificar os motoristas por sua distância real de viagem ou tempo do restaurante.

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 de sincronização é de 2500 (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 2500, convém fazer uma solicitação síncrona. O tamanho máximo de uma matriz para esta API é 2500 (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: 50x50, 60x40, 90x20 (não precisa ser quadrado).

Limitações da API

O processamento síncrono da matriz é mais adequado para matrizes pequenas e rápidas de cálculo de rota. Para calcular matrizes maiores e cálculo de rota pesada, use o ponto de extremidade assíncrono. A limitação a seguir é aplicável às solicitações sí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.

Exemplos:

• Solicitação de matriz 10x20 com traffic=live: Esta solicitação será processada com um limite de caixa delimitadora, pois corresponde a um limite de até 200, o que inclui restrições de caixa delimitadora.

• Solicitação de matriz 10x20 com parâmetros padrão (traffic=historical): Esta solicitação será processada sem um limite de caixa delimitadora, pois corresponde a um limite de até 2500, que não impõe restrições de caixa delimitadora.

POST https://atlas.microsoft.com/route/matrix?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

Successfully retrieve a route matrix with additional parameters in the body

POST https://atlas.microsoft.com/route/matrix?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"
  ]
}

{
  "type": "Feature",
  "geometry": null,
  "properties": {
    "summary": {
      "totalCount": 4,
      "successfulCount": 4
    },
    "matrix": [
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 21007,
        "durationInSeconds": 21007,
        "distanceInMeters": 492466,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:30:03+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 33623,
        "durationInSeconds": 33623,
        "distanceInMeters": 877028,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T02:00:19+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 19520,
        "durationInSeconds": 19520,
        "distanceInMeters": 427769,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:05:16+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 32070,
        "durationInSeconds": 32070,
        "distanceInMeters": 836080,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T01:34:27+01:00"
      }
    ]
  }
}

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.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

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.

RouteMatrixAsyncResponse

Especifica as instruções de condução e as propriedades adicionais para cada ponto de manobra na perna do percurso.

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.

RouteMatrixFeatureProperties

Propriedades da matriz de rota.

RouteMatrixItemResult

Resultado do item Route Matrix

RouteMatrixOptimizeRouteEnum

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":"fastest "

RouteMatrixRequest

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.

RouteMatrixResponse

Este objeto é retornado de uma chamada bem-sucedida.

RouteMatrixSummary

Resumo da solicitação de matriz de rota

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.

RouteOperationKindEnum

Tipo de operação assíncrona

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.