Spatial - Get Great Circle Distance

Référence

Service:: Maps

API Version:: 2022-08-01

Permet de déterminer la distance la plus courte entre deux points sur la surface d’une sphère.

L’API Get Great Circle Distance est une requête HTTP GET qui retourne la distance la plus courte ou grande entre deux points de la surface d’une sphère, mesurée le long de la surface de la sphère. Cela diffère du calcul d’une ligne droite à travers l’intérieur de la sphère. Cette méthode est utile pour estimer les distances de trajet des avions en calculant la distance la plus courte entre les aéroports.

GET https://{geography}.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query={query}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
geography	path	True	string	Emplacement du compte Azure Maps. Les valeurs valides sont us (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest). Ce paramètre est requis lorsqu’un `udid` est fourni dans la demande. Par exemple, si le compte Azure Maps se trouve dans USA Est, seules les demandes qui nous sont adressées en zone géographique seront acceptées.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
query	query	True	string	Coordonnées par lesquelles la distance est calculée, délimitée par un signe deux-points. Deux coordonnées sont requises. La première est la coordonnée du point source et la dernière est la coordonnée de point cible. Par exemple, 47.622942,122.316456 :57.673988,127.121513

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie quel compte est destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	GreatCircleDistanceResult	Ok
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

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

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

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

Authorization URL est spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

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 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 actuellement être traitées comme master clés du compte pour lequel elles sont émises.

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

Type: apiKey
In: 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 Portail Azure, PowerShell, CLI, kits SDK Azure ou 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 de grain 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, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
In: header

Exemples

GetGreatCircleDistance

Sample Request

HTTP

GET https://us.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query=47.622942,-122.316456:47.610378,-122.200676

Sample Response

Status code:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 47.622942,
      "lon": -122.316456
    },
    "targetPoint": {
      "lat": 47.610378,
      "lon": -122.200676
    }
  },
  "result": {
    "distanceInMeters": 8797.62
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GreatCircleDistanceResult	Cet objet est retourné à partir d’un appel de grande distance de cercle réussi
GreatCircleDistanceSummary	Objet Summary
JsonFormat	Format souhaité de la réponse. Seul le format `json` est pris en charge.
LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
Result	Point dans l’objet Résultat polygonal

ErrorAdditionalInfo

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

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GreatCircleDistanceResult

Cet objet est retourné à partir d’un appel de grande distance de cercle réussi

Nom	Type	Description
result	Result	Objet Result
summary	GreatCircleDistanceSummary	Objet Summary

GreatCircleDistanceSummary

Objet Summary

Nom	Type	Description
sourcePoint	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
targetPoint	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

JsonFormat

Format souhaité de la réponse. Seul le format json est pris en charge.

Nom	Type	Description
json	string	Format d’échange de données de notation d’objet JavaScript

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

Nom	Type	Description
lat	number	Propriété Latitude
lon	number	Longitude, propriété

Result

Point dans l’objet Résultat polygonal

Nom	Type	Description
intersectingGeometries	string[]	Tableau de géométries
pointInPolygons	boolean	Point in Polygons, propriété

Share via