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 faz um pedido usando um pedido assíncrono, por defeito o serviço devolve um código de resposta 202 ao longo de uma URL no campo operation-Location do cabeçalho de resposta com o endpoint Azure Maps geography {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 um pedido Route Matrix POST 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.

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

|------------------|-----------------------|-----------------------------|-------------------| | 2500 | 1000 | 1000 | Todas as origens e destinos devem estar contidos numa caixa delimitadora alinhada com eixos de 400 km x 400 km. Caso contrário, algumas células da matriz serão resolvidas como OUT_OF_REGION.  | | 50.000 | 10.000 | 10.000 | - departAt ou arriveAt deve haver algum.
- traffic deve ser histórico.
- optimizeRoute deve ser mais rápido.
- travelMode deve estar dirigindo ou caminhando. 
- Nenhum outro parâmetro pode ser usado explicitamente.  |

POST {endpoint}/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 fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode receber acesso através de um papel incorporado ou de um papel personalizado composto por uma ou mais permissões para Azure Maps APIs REST.\n\nPara implementar cenários, recomendamos consultar conceitos autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações(ões) através de objetos capazes de controlo de acesso em APIs e escopos específicos.\n\n#### Notas\n* Esta definição de segurança exige a utilização do cabeçalho x-ms-client-id para indicar a que Azure Maps recurso a aplicação está a pedir acesso. Isto pode ser adquirido da API de gestão Maps.\n* \nO Authorization URL é específico para a instância Azure cloud pública. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas. \n* \nO controlo de acesso Azure baseado em funções é configurado a partir do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n* \nUtilização do Azure Maps Web SDK permite a configuração de uma aplicação para múltiplos casos de uso.\n* Para mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft visão geral.

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

Âmbitos

subscription-key

Esta é uma chave partilhada que é provisionada quando Cria uma conta Azure Maps no portal Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.\n\n Com esta chave, qualquer aplicação pode aceder a toda a API REST. Ou seja, esta chave pode ser usada como chave mestra na conta onde são emitidas.\n\n Para aplicações expostas publicamente, a nossa recomendação é usar a abordagem confidenciais de aplicações cliente para aceder às APIs REST Azure Maps para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso Azure Maps através do plano de gestão Azure via portal Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.\n\n Com este token, qualquer aplicação está autorizada a aceder com Azure controlos de acesso baseados em funções e controlo minucioso da expiração, taxa e região(s) de utilização para o token em questão. Por outras palavras, o Token SAS pode ser usado para permitir que aplicações controlem o acesso de forma mais segura do que a chave partilhada.\n\n Para aplicações publicamente expostas, a 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

Submit an asynchronous request for matrix

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

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.

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 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 comum ao erro para APIs do Azure Maps 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.

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.