Route - Post Route Matrix Async

L’API Route Matrix Async 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 asynchrone (asynchrone). 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.

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.

La taille maximale d’une matrice pour la requête asynchrone est 5 0000 (le nombre d’origines multiplié par le nombre de destinations).

Envoyer une demande de matrice de routage asynchrone

L’API asynchrone convient au traitement de gros volumes de demandes de routage relativement complexes. Lorsque vous effectuez une requête à l’aide d’une requête asynchrone, par défaut, le service retourne un code de réponse 202 le long d’une URL dans le champ operation-Location de l’en-tête de réponse avec le point de terminaison géographique Azure Maps « {geography}.atlas.microsoft.com. Cette URL doit être vérifiée régulièrement jusqu’à ce que l’état soit réussi.

La taille maximale d’une matrice pour cette API est 5 000 (le nombre d’origines multiplié par le nombre de destinations). Avec cette contrainte à l’esprit, des exemples de dimensions de matrice possibles sont : 500x100, 100x100, 280x170. 100x50 (il n’est pas nécessaire d’être carré).

Les réponses asynchrones sont stockées pendant 24 heures. L’URL de redirection retourne une réponse 404 si elle est utilisée après la période d’expiration.

POST https://atlas.microsoft.com/route/matrix:async?api-version=2025-01-01&subscription-key={subscription-key}

Voici une séquence classique d’opérations asynchrones :

1. Le client envoie une requête POST de matrice de routage à Azure Maps

2. Le serveur répond avec l’une des options suivantes :

   HTTP 202 Accepted : la demande de matrice de routage a été acceptée.

   HTTP Error : une erreur s’est produite lors du traitement de votre demande de matrice de routage. Il peut s’agir d’une demande incorrecte 400 ou d’un autre code d’état d’erreur.

3. Si la requête Matrix Route a été acceptée avec succès, l’en-tête operation-location dans la réponse contient l’URL pour obtenir l’état de la demande. Cet URI d’état se présente comme suit :

  GET https://atlas.microsoft.com/route/operations/{id}?api-version=2025-01-01?subscription-key={subscription-key}

4. Le client émet une requête GET sur le resultUrl obtenu à l’étape 3 pour obtenir les résultats

  GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2025-01-01?subscription-key={subscription-key}

Limitations de l’API

Le traitement asynchrone de la matrice convient le mieux aux matrices plus volumineuses qui nécessitent un calcul de routage lourd. La limitation suivante s’applique aux requêtes asynchrones. 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.

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

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

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.

FeaturesItemTypeEnum

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

FeatureTypeEnum

Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. Pour plus d’informations, consultez 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. Pour plus d’informations, reportez-vous à RFC 7946.

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.

RouteMatrixAsyncOptimizeRouteEnum

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 » : « shortest »

RouteMatrixAsyncRequest

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. Pour plus d’informations, reportez-vous à RFC 7946.

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.

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.

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.