Route - Post Snap To Roads

L’API Snap to Roads accepte les données de point GPS, représentées sous forme de coordonnées de longitude et de latitude, et génère des points qui s’alignent sur les routes existantes sur une carte. Ce processus, appelé « alignement sur les routes », produit une série d’objets qui tracent un chemin en suivant étroitement le réseau routier. Les données obtenues incluent les noms de routes et leurs limites de vitesse respectives, pertinentes pour les segments parcourus.

De plus, l’API Snap to Roads offre une fonctionnalité d’interpolation, qui affine les points GPS pour créer un itinéraire plus lisse qui respecte la géométrie de la route. Cette fonctionnalité est particulièrement bénéfique pour le suivi des ressources et l’amélioration de la visualisation des données dans les applications de mappage.

Pour des informations sur la disponibilité du routage dans les pays/régions, voir Azure Maps couverture de routage.

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

Ce sont les flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès basé sur Azure par rôle, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès basés sur les rôles Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes ou sous-ressources de ressources Azure Maps. 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 lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse ê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 snap to roads points with additional parameters in the body

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

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.336729,
          47.590868
        ]
      },
      "properties": {}
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.336042,
          47.601604
        ]
      },
      "properties": {}
    }
  ],
  "includeSpeedLimit": true,
  "travelMode": "driving"
}

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.336769,
          47.590885
        ]
      },
      "properties": {
        "name": "State Rte-99 N",
        "inputIndex": 0,
        "isInterpolated": false,
        "speedLimitInKilometersPerHour": 80
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.336008,
          47.601609
        ]
      },
      "properties": {
        "name": "State Rte-99 N",
        "inputIndex": 1,
        "isInterpolated": false,
        "speedLimitInKilometersPerHour": 80
      }
    }
  ]
}

Définitions

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.

GeoJsonObjectType

Spécifie le type GeoJSON. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

GeoJsonPoint

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

InputSnapToRoadsFeaturesItem

Spécifie le composant logiciel enfichable d’entrée aux points de routes. GeoJSON objet de fonctionnalité et des propriétés supplémentaires. Pour plus d’informations, reportez-vous à RFC 7946.

MapsErrorDetail

Détail de l’erreur.

MapsErrorResponse

Réponse à l’erreur courante pour les API Azure Maps afin de renvoyer les détails d’erreur en cas d’échec des opérations.

MapsInnerError

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

SnapToRoadFeaturesItem

Objet de fonctionnalité GeoJSON qui contient l’objet Geometry et les propriétés supplémentaires de l’itinéraire.

SnapToRoadsFeatureProperties

Accrochage aux propriétés Routes.

SnapToRoadsRequest

Cet objet est le corps de la requête.

SnapToRoadsResponse

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

SnapToRoadsTravelModeEnum

Spécifie le profil de routage pour l’alignement des points. S’il n’est pas spécifié, le mode par défaut est « conduite », ce qui optimise les points alignés pour les itinéraires de conduite.