Route - Post Route Matrix

L’API Route Matrix est une requête HTTP POST qui permet le calcul d’une matrice de résumés d’itinéraires pour un ensemble d’itinéraires définis par les emplacements d’origine et de destination à l’aide d’une requête de synchronisation. Pour chaque origine donnée, le service calcule le coût du routage de cette origine vers chaque destination donnée. L’ensemble d’origines et l’ensemble de destinations peuvent être considérés comme les en-têtes de colonne et de ligne d’une table et chaque cellule du tableau contient les coûts de routage de l’origine vers la destination de cette cellule. Les matrices d’itinéraire peuvent être calculées pour la conduite, la marche et les itinéraires de camion. Par exemple, une entreprise de livraison de nourriture a 20 chauffeurs et ils doivent trouver le chauffeur le plus proche pour récupérer la livraison à partir du restaurant. Pour résoudre ce cas d’usage, ils peuvent appeler l’API Route Matrix et utiliser le coût de déplacement pour trier les conducteurs en fonction de leur distance de trajet ou de leur temps réel à partir du restaurant.

Les matrices de routage sont utilisées dans plusieurs types d’applications différents, le plus souvent pour résoudre le problème du vendeur itinérant (TSP) et le problème de routage des véhicules (VRP). Pour chaque paire d’origine-destination dans la matrice, le temps de trajet et la distance sont retournés. Vous pouvez utiliser les coûts calculés pour déterminer les itinéraires détaillés à calculer à l’aide de l’API Route Directions.

Taille maximale d’une matrice pour la demande de synchronisation, elle est 2500 (le nombre d’origines multiplié par le nombre de destinations).

Envoyer une demande de matrice de routage synchrone

Si votre scénario nécessite des requêtes synchrones et que la taille maximale de la matrice est inférieure ou égale à 2500, vous souhaiterez peut-être effectuer une requête synchrone. La taille maximale d’une matrice pour cette API est 2500 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, les exemples de dimensions de matrice possibles sont : 50x50, 60x40, 90x20 (il n’est pas nécessaire d’être carré).

Limitations de l’API

Le traitement synchrone de la matrice convient le mieux aux petites matrices rapides de calcul de routage. Pour calculer des matrices plus volumineuses et un calcul de routage lourd, utilisez le point de terminaison asynchrone. La limitation suivante s’applique aux requêtes synchrones. Si aucune des lignes du tableau suivant ne correspond aux paramètres de la requête, la demande ne répond pas aux exigences et ne sera pas traitée.

Exemples:

• Requête de matrice 10x20 avec traffic=live: cette requête sera traitée avec une limite de cadre englobante, car elle correspond à une limite allant jusqu’à 200, qui inclut des restrictions de cadre englobant.

• Requête de matrice 10x20 avec des paramètres par défaut (traffic=historical) : cette requête sera traitée sans limite de cadre englobant, car elle correspond à une limite allant jusqu’à 2500, qui n’impose pas de restrictions de zone englobante.

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

Paramètres URI

En-tête de la demande

Media Types: "application/geo+json"

Corps de la demande

Media Types: "application/geo+json"

Réponses

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

subscription-key

Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut être stockée en toute sécurité.

Type: apiKey
Dans: header

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

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"
      }
    ]
  }
}

Définitions

AdrTunnelRestrictionCodeEnum

Code de restriction du tunnel ADR. L’ADR est un accord européen concernant le transport international de marchandises dangereuses par route. Le code de restriction du tunnel ADR est utilisé pour déterminer si un véhicule est autorisé à traverser un tunnel avec des restrictions sur le transport de marchandises dangereuses.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

FeaturesItemTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est Feature. Pour plus d’informations, consultez la RFC 7946.

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. Pour plus d’informations, consultez la RFC 7946.

GeoJsonMultiPoint

Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.

InputRouteMatrixFeaturesItem

Spécifie les points d’origine et de destination d’entrée et les propriétés supplémentaires pour l’objet de fonctionnalité MultiPoint GeoJSON. Reportez-vous à la RFC 7946 pour plus de détails.

InputRouteMatrixProperties

Spécifie l’objet de propriétés de la matrice d’entrée.

MapsErrorDetail

Détail de l’erreur.

MapsErrorResponse

Réponse d’erreur courante pour les API Azure Maps pour retourner les détails d’erreur pour les opérations ayant échoué.

MapsInnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

RouteMatrixAsyncResponse

Spécifie les instructions de conduite et les propriétés supplémentaires pour chaque point de manœuvre dans la jambe de route.

RouteMatrixAvoidEnum

Spécifie les restrictions que le calcul de l’itinéraire doit respecter lors de la détermination de l’itinéraire. Évitez de prendre en charge plusieurs valeurs dans une demande et n’est prise en charge que pour la conduite et le travelMode de camion.

RouteMatrixFeatureProperties

Propriétés de matrice de routage.

RouteMatrixItemResult

Résultat de l’élément De matrice de routage

RouteMatrixOptimizeRouteEnum

Spécifie le paramètre à utiliser pour optimiser l’itinéraire. S’il n’est pas défini, la valeur par défaut est « la plus rapide » qui retourne l’itinéraire pour réduire le temps de trajet.

Exemple : « optimizeRoute » : « le plus rapide »

RouteMatrixRequest

Permet d’obtenir une matrice d’itinéraire montrant le temps de trajet et la distance pour toutes les paires possibles dans une liste d’origines et de destination. GeoJSON objet de fonctionnalité et des propriétés supplémentaires. Reportez-vous à la RFC 7946 pour plus de détails.

RouteMatrixResponse

Cet objet est retourné à partir d’un appel réussi.

RouteMatrixSummary

Résumé de la demande de matrice de routage

RouteMatrixTrafficEnum

Spécifie la façon dont le trafic est pris en compte pour les itinéraires informatiques.

Valeur par défaut : historical

RouteMatrixTravelModeEnum

Spécifie le profil de voyage à prendre en compte lors du calcul de la matrice. Si elle n’est pas spécifiée, la valeur par défaut est « driving ».

Exemple : « travelMode » :"driving »

RouteMatrixTypeEnum

Spécifie le type MultiPoint d’origine et le type MultiPoint de destination pour la matrice d’entrée.

RouteMatrixVehicleSpec

Spécifie les attributs du véhicule tels que la hauteur, le poids, la vitesse maximale, le type de cargaison, etc. à prendre en compte lors du calcul de la matrice de routage. Cela permet d’éviter les dégagements de pont bas, les restrictions routières, les virages de droite difficiles pour fournir l’itinéraire optimisé en fonction des spécifications du véhicule. Les attributs de véhicule sont spécifiés dans la propriété vehicleSpec.

RouteOperationKindEnum

Type d’opération asynchrone

VehicleLoadTypeEnum

Types de cargaisons pouvant être classifiées comme matières dangereuses et restreintes à partir de certaines routes. Les valeurs vehicleLoadType disponibles sont les classes hazmat américaines 1 à 9, ainsi que les classifications génériques à utiliser dans d’autres pays. Les valeurs commençant par USHazmat sont destinées au routage américain, tandis que d’autresHazmat doivent être utilisées pour tous les autres pays. vehicleLoadType prend en charge plusieurs valeurs dans une requête.