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 plus d’informations sur la disponibilité du routage dans les pays/régions, consultez couverture du routage Azure Maps.

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

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 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": {
        "coordinates": [
          -122.336729,
          47.590868
        ],
        "type": "Point"
      },
      "properties": {}
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336042,
          47.601604
        ],
        "type": "Point"
      },
      "properties": {}
    }
  ],
  "includeSpeedLimit": true,
  "travelMode": "driving"
}

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

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. Reportez-vous à la RFC 7946 pour plus de détails.

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.

PointGeometry

Point d’origine passé en tant qu’objet Geometry GeoJSON valide, à partir duquel le polygone de plage doit être calculé. Pour plus d’informations, reportez-vous à RFC 7946.

Note: l’API aligne le point d’origine demandé sur le réseau routier le plus proche et l’utilise pour le calcul de plage. Elle est retournée en tant que point de center dans la réponse.

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.