Search - Get Reverse Geocoding
Utilisez pour obtenir une adresse postale et des informations de localisation à partir de coordonnées de longitude et de latitude.
L’API Get Reverse Geocoding
est une requête HTTP GET
utilisée pour traduire une coordonnée (exemple : 37.786505, -122.3862) en une adresse postale compréhensible par l’homme. Utile dans les applications de suivi où vous recevez un flux GPS de l’appareil ou de la ressource et souhaitez connaître l’adresse associée aux coordonnées. Ce point de terminaison retourne les informations d’adresse d’une coordonnée donnée.
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
coordinates
|
query | True |
number[] |
Coordonnées de l’emplacement que vous souhaitez inverser le géocode. Exemple : &coordinates=lon,lat |
result
|
query |
Spécifiez les types d’entités souhaités dans la réponse. Seuls les types que vous spécifiez sont retournés. Si le point ne peut pas être mappé aux types d’entités que vous spécifiez, aucune information d’emplacement n’est retournée dans la réponse. La valeur par défaut est toutes les entités possibles. Liste séparée par des virgules des types d’entités sélectionnés parmi les options suivantes.
Ces types d’entités sont classés de l’entité la plus spécifique à l’entité la moins spécifique. Lorsque des entités de plusieurs types d’entités sont trouvées, seule l’entité la plus spécifique est retournée. Par exemple, si vous spécifiez Address et AdminDistrict1 comme des types d’entités et des entités ont été trouvés pour les deux types, seules les informations d’entité Address sont retournées dans la réponse. |
||
view
|
query |
string |
Chaîne qui représente un code de région/pays ISO 3166-1 Alpha-2. Cela modifie les frontières et les étiquettes géopolitiques contestées pour s’aligner sur la région d’utilisateur spécifiée. Par défaut, le paramètre View est défini sur « Auto », même si vous ne l’avez pas défini dans la requête. Reportez-vous à Vues prises en charge pour plus d’informations et pour voir les vues disponibles. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. 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 la sécurité Azure AD dans Azure Maps, consultez les articles suivants pour obtenir des conseils. |
|
Accept-Language |
string |
Langue dans laquelle les résultats de la recherche doivent être retournés. Pour plus d’informations, consultez Langues prises en charge . |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok Media Types: "application/geo+json" |
|
Other Status Codes |
Une erreur inattendue s’est produite. Media Types: "application/geo+json" |
Sécurité
AADToken
Il s’agit des flux OAuth Microsoft Entra 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 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 Ou sous-ressources Azure Maps. 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 aux API REST Azure Maps.
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 à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. - Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
- L’utilisation du KIT de développement logiciel (SDK) web Azure Maps permet d’configurer une application en fonction de la configuration pour plusieurs cas d’usage.
- Pour plus d’informations sur la plateforme d’identités Microsoft, consultez Vue d’ensemble de la plateforme d’identités Microsoft.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée qui est provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, celles-ci peuvent actuellement être traitées comme des clés principales du compte pour lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès de 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, l’interface CLI, les SDK Azure 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 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
Dans:
header
Exemples
Search point -122.138681, 47.630358
Exemple de requête
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates=-122.138681,47.630358
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1386787,
47.6302179
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"bbox": [
-122.14632282407,
47.626495282429325,
-122.13103917593001,
47.63422071757068
]
}
]
}
Définitions
Nom | Description |
---|---|
Address |
Adresse du résultat |
Admin |
Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région. |
Calculation |
Méthode utilisée pour calculer le point de géocode. |
Confidence |
Niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance. La confiance d’un emplacement géocodé est basée sur de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et de l’emplacement de l’utilisateur, le cas échéant. |
Country |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Feature |
Le type d’un objet FeatureCollection doit être FeatureCollection. |
Features |
|
Feature |
Le type d’une fonctionnalité doit être Fonctionnalité. |
Geocode |
Collection de points de géocode qui diffèrent par leur mode de calcul et leur utilisation suggérée. |
Geocoding |
Cet objet est retourné à partir d’un appel de géocodage réussi |
Geo |
Type de géométrie valide |
Intersection |
Adresse du résultat. |
Match |
Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage pour chaque emplacement dans la réponse. Par exemple, un emplacement géocodé avec les codes de correspondance de De même, un emplacement géocodé avec des codes de correspondance de Les valeurs possibles sont les suivantes :
|
Properties | |
Reverse |
Spécifiez les types d’entités souhaités dans la réponse. Seuls les types que vous spécifiez sont retournés. Si le point ne peut pas être mappé aux types d’entités que vous spécifiez, aucune information d’emplacement n’est retournée dans la réponse. La valeur par défaut est toutes les entités possibles. Liste séparée par des virgules des types d’entités sélectionnés parmi les options suivantes.
Ces types d’entités sont classés de l’entité la plus spécifique à l’entité la moins spécifique. Lorsque des entités de plusieurs types d’entités sont trouvées, seule l’entité la plus spécifique est retournée. Par exemple, si vous spécifiez Address et AdminDistrict1 comme des types d’entités et des entités ont été trouvés pour les deux types, seules les informations d’entité Address sont retournées dans la réponse. |
Usage |
Meilleure utilisation pour le point de géocode.
Chaque point de géocode est défini en tant que |
Address
Adresse du résultat
Nom | Type | Description |
---|---|---|
addressLine |
string |
AddressLine qui comprend le nom de la rue et le numéro |
adminDistricts |
Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région. |
|
countryRegion | ||
formattedAddress |
string |
Propriété Adresse mise en forme |
intersection |
Adresse du résultat. |
|
locality |
string |
locality, propriété |
neighborhood |
string |
propriété de voisinage |
postalCode |
string |
Propriété Code postal |
AdminDistricts
Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région.
Nom | Type | Description |
---|---|---|
name |
string |
Nom du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir du nom complet de l’état tel que Washington, For adminDistrict[1], il peut s’agir du nom complet du comté |
shortName |
string |
Nom court du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir d’un nom court d’état, tel que WA, For adminDistrict[1], il peut s’agir du nom court du comté |
CalculationMethodEnum
Méthode utilisée pour calculer le point de géocode.
Nom | Type | Description |
---|---|---|
Interpolation |
string |
Le point de géocode a été mis en correspondance avec un point sur une route à l’aide de l’interpolation. |
InterpolationOffset |
string |
Le point de géocode a été mis en correspondance avec un point sur une route à l’aide de l’interpolation avec un décalage supplémentaire pour déplacer le point sur le côté de la rue. |
Parcel |
string |
Le point de géocode a été mis en correspondance au centre d’un colis. |
Rooftop |
string |
Le point de géocode a été mis en correspondance avec le toit d’un bâtiment. |
ConfidenceEnum
Niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance.
La confiance d’un emplacement géocodé est basée sur de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et de l’emplacement de l’utilisateur, le cas échéant.
Nom | Type | Description |
---|---|---|
High |
string |
Si la confiance est définie sur Si une demande inclut un emplacement ou une vue, le classement peut changer de manière appropriée. Par exemple, une requête d’emplacement pour « Paris » retourne « Paris, France » et « Paris, TX » en toute |
Low |
string |
|
Medium |
string |
Dans certains cas, la correspondance retournée peut ne pas être au même niveau que les informations fournies dans la demande. Par exemple, une demande peut spécifier des informations d’adresse et le service de géocode peut uniquement correspondre à un code postal. Dans ce cas, si le service de géocode a l’assurance que le code postal correspond aux Si les informations d’emplacement dans la requête sont ambiguës et qu’il n’existe aucune information supplémentaire pour classer les emplacements (par exemple, l’emplacement de l’utilisateur ou l’importance relative de l’emplacement), la confiance est définie sur Si les informations d’emplacement dans la requête ne fournissent pas suffisamment d’informations pour géocoder un emplacement spécifique, une valeur d’emplacement moins précise peut être retournée et la confiance est définie sur |
CountryRegion
Nom | Type | Description |
---|---|---|
ISO |
string |
ISO du pays/région |
name |
string |
nom du pays/de la région |
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 |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
FeatureCollectionEnum
Le type d’un objet FeatureCollection doit être FeatureCollection.
Nom | Type | Description |
---|---|---|
FeatureCollection |
string |
FeaturesItem
Nom | Type | Description |
---|---|---|
bbox |
number[] |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, consultez RFC 7946 . |
geometry |
Type de géométrie valide |
|
id |
string |
ID pour la fonctionnalité retournée |
properties | ||
type |
Le type d’une fonctionnalité doit être Fonctionnalité. |
FeatureTypeEnum
Le type d’une fonctionnalité doit être Fonctionnalité.
Nom | Type | Description |
---|---|---|
Feature |
string |
GeocodePoints
Collection de points de géocode qui diffèrent par leur mode de calcul et leur utilisation suggérée.
Nom | Type | Description |
---|---|---|
calculationMethod |
Méthode utilisée pour calculer le point de géocode. |
|
geometry |
Type de géométrie valide |
|
usageTypes |
Meilleure utilisation pour le point de géocode.
Chaque point de géocode est défini en tant que |
GeocodingResponse
Cet objet est retourné à partir d’un appel de géocodage réussi
Nom | Type | Description |
---|---|---|
features | ||
nextLink |
string |
est le lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, non ce champ. |
type |
Le type d’un objet FeatureCollection doit être FeatureCollection. |
GeoJsonPoint
Type de géométrie valide GeoJSON Point
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
bbox |
number[] |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, consultez RFC 7946 . |
coordinates |
number[] |
Un |
type |
string:
Point |
Spécifie le type |
Intersection
Adresse du résultat.
Nom | Type | Description |
---|---|---|
baseStreet |
string |
Rue principale de l’emplacement. |
displayName |
string |
Nom complet de l’intersection. |
intersectionType |
string |
Type d’intersection. |
secondaryStreet1 |
string |
La première rue qui se croise. |
secondaryStreet2 |
string |
Le cas échéant, la deuxième rue qui se croise. |
MatchCodesEnum
Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage pour chaque emplacement dans la réponse.
Par exemple, un emplacement géocodé avec les codes de correspondance de Good
et Ambiguous
signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations d’emplacement et que le service de géocode n’avait pas de recherche dans la hiérarchie supérieure pour trouver une correspondance.
De même, un emplacement géocodé avec des codes de correspondance de Ambiguous
et UpHierarchy
implique qu’il n’est pas possible de trouver un emplacement de géocodage correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocode a dû rechercher dans la hiérarchie supérieure et trouver plusieurs correspondances à ce niveau. Un exemple de Ambiguous
résultat et UpHierarchy
est lorsque vous fournissez des informations d’adresse complètes, mais le service de géocode ne peut pas localiser une correspondance pour l’adresse postale et retourne plutôt des informations pour plusieurs valeurs RoadBlock.
Les valeurs possibles sont les suivantes :
Good
: l’emplacement n’a qu’une seule correspondance ou toutes les correspondances retournées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York retourne plusieurs bonnes correspondances.
Ambiguous
: l’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse de rue 128 Main St., la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St. parce qu’il n’y a pas suffisamment d’informations pour déterminer l’option à choisir.
UpHierarchy
: l’emplacement représente un déplacement vers le haut de la hiérarchie géographique. Cela se produit lorsqu’une correspondance pour la demande d’emplacement n’a pas été trouvée, de sorte qu’un résultat moins précis est retourné. Par exemple, si une correspondance pour l’adresse demandée est introuvable, un code de correspondance de UpHierarchy
avec un type d’entité RoadBlock peut être retourné.
Nom | Type | Description |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
Nom | Type | Description |
---|---|---|
address |
Adresse du résultat |
|
confidence |
Niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance. La confiance d’un emplacement géocodé est basée sur de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et de l’emplacement de l’utilisateur, le cas échéant. |
|
geocodePoints |
Collection de points de géocode qui diffèrent par leur mode de calcul et leur utilisation suggérée. |
|
matchCodes |
Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage pour chaque emplacement dans la réponse. Par exemple, un emplacement géocodé avec les codes de correspondance de De même, un emplacement géocodé avec des codes de correspondance de Les valeurs possibles sont les suivantes :
|
|
type |
string |
Valeurs possibles :
|
ReverseGeocodingResultTypeEnum
Spécifiez les types d’entités souhaités dans la réponse. Seuls les types que vous spécifiez sont retournés. Si le point ne peut pas être mappé aux types d’entités que vous spécifiez, aucune information d’emplacement n’est retournée dans la réponse. La valeur par défaut est toutes les entités possibles. Liste séparée par des virgules des types d’entités sélectionnés parmi les options suivantes.
- Adresse
- Voisinage
- PopulatedPlace
- Code postal1
- AdminDivision1
- AdminDivision2
- CountryRegion
Ces types d’entités sont classés de l’entité la plus spécifique à l’entité la moins spécifique. Lorsque des entités de plusieurs types d’entités sont trouvées, seule l’entité la plus spécifique est retournée. Par exemple, si vous spécifiez Address et AdminDistrict1 comme des types d’entités et des entités ont été trouvés pour les deux types, seules les informations d’entité Address sont retournées dans la réponse.
Nom | Type | Description |
---|---|---|
Address |
string |
|
AdminDivision1 |
string |
|
AdminDivision2 |
string |
|
CountryRegion |
string |
|
Neighborhood |
string |
|
PopulatedPlace |
string |
|
Postcode1 |
string |
UsageTypeEnum
Meilleure utilisation pour le point de géocode.
Chaque point de géocode est défini en tant que Route
point, point Display
ou les deux.
Utilisez des Route
points si vous créez un itinéraire vers l’emplacement. Utilisez des Display
points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un Route
point peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un Display
point peut être un point qui spécifie le centre du parc.
Nom | Type | Description |
---|---|---|
Display |
string |
|
Route |
string |