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 determinada, o serviço calcula o custo de roteamento dessa origem para cada destino determinado. Os conjuntos de origens e destinos podem ser vistos como os cabeçalhos de colunas e linhas de uma tabela, onde cada célula contém o custo de deslocamento do local de origem para o destino correspondente dessa célula. Matrizes de rota podem ser calculadas para rotas de condução, caminhada e caminhão. Por exemplo, uma empresa de entrega de alimentos tem 20 motoristas e eles precisam encontrar o motorista mais próximo para pegar a entrega do restaurante. Para resolver esse caso de uso, eles podem chamar a API de Matriz de Rotas e usar o custo de viagem para classificar os motoristas por sua distância ou tempo de viagem real do restaurante.

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 de sincronização é 2500 (o número de origens multiplicada pelo número de destinos).

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

Se o 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 essa API é 2500 (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: 50x50, 60x40, 90x20 (não precisa ser quadrado).

Limitações da API

O processamento síncrono da matriz é mais adequado para matrizes rápidas e pequenas do 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 na tabela a seguir corresponder aos parâmetros da solicitação, a solicitação não atenderá aos requisitos e não será processada.

| Tamanho máximo da matriz | Número máximo de origens | Número máximo de destinos | Limites adicionais

|------------------|------------------------|----------------------------|------------| | 100 | 100 | 100 | N/A | | 200 | 200 | 200 | Todas as origens e destinos devem estar contidos em uma caixa delimitadora alinhada com eixos de 400 km x 400 km. Caso contrário, algumas células de matriz serão resolvidas como OUT_OF_REGION. | | 2500 | 1000 | 1000 | - departAt Ou arriveAt deve ser algum.
- traffic deve ser histórico.
- travelMode deve estar dirigindo ou caminhão
- Nenhum outro parâmetro pode ser usado explicitamente |

Exemplos:

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

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

POST {endpoint}/route/matrix?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

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com o controle de acesso baseado em funções Azure , pode ser usado para controlar o acesso às APIs REST Azure Mapas. Controles de acesso baseados em função do Azure são usados para designar acesso a uma ou mais contas ou subrecursos de recursos do Azure Mapas. Qualquer usuário, grupo ou principal de serviço pode receber acesso via um papel embutido ou um papel personalizado composto por uma ou mais permissões para Azure Mapas APIs REST.\n\nPara implementar cenários, recomendamos visualizar conceitos autenticação. Em resumo, essa definição de segurança fornece uma solução para modelagem de aplicações(ões) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige o uso do cabeçalho x-ms-client-id para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento Maps.\n* \nO Authorization URL é específico para a instância Azure nuvem pública. As nuvens soberanas possuem URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controle de acesso baseado em função Azure é configurado a partir do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUso do Azure Mapas Web SDK permite a configuração de uma aplicação baseada em configuração para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidade da Microsoft, veja plataforma de identidade da Microsoft visão geral.

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

Escopos

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta Azure Mapas no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que são emitidas.\n\n Para aplicações publicamente expostas, nossa recomendação é usar a abordagem confidenciais de aplicativos clientes para acessar APIs REST Azure Mapas e assim sua chave possa 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 List SAS no recurso Azure Mapas através do plano de gerenciamento Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicativo está autorizado a acessar com Azure controles de acesso baseados em funções e controle detalhado da expiração, taxa e região(s) de uso do token específico. Em outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave compartilhada.\n\n Para aplicações publicamente expostas, nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta Map para limitar abusos 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 {endpoint}/route/matrix?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "avoid": [
    "unpavedRoads"
  ],
  "departAt": "2022-12-19T16:39:57+01:00",
  "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"
      }
    }
  ],
  "optimizeRoute": "fastest",
  "traffic": "historical",
  "travelMode": "truck"
}

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

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.

CommonErrorDetail

O detalhe do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

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.

GeoJsonObjectType

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

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 comum de erro para APIs do Azure Mapas devolver detalhes de erro em operações falhadas.

MapsInnerError

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

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.

RouteMatrixFeatureProperties

Propriedades de Matriz de Rota.

RouteMatrixItemResult

Resultado do item de Matriz de Rota

RouteMatrixOptimizeRouteEnum

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":"mais rápido"

RouteMatrixRequest

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.

RouteMatrixResponse

Esse objeto é retornado de uma chamada bem-sucedida.

RouteMatrixSummary

Resumo da solicitação de matriz de rotas

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.