Search - Get Search Address Reverse

Référence

Service:: Maps

Version d'API:: 1.0

Utilisez pour obtenir une adresse postale et des informations d’emplacement à partir de coordonnées de latitude et de longitude.
L’API Get Search Address Reverse est et la requête HTTP GET qui retourne une adresse postale ou un emplacement lorsque les coordonnées de latitude et de longitude sont données.

Il peut arriver que vous deviez traduire une coordonnée (exemple : 37.786505, -122.3862) en une adresse postale compréhensible par l’homme. Le plus souvent, cela est nécessaire dans les applications de suivi où vous recevez un flux GPS de l’appareil ou d’une ressource, et souhaitez connaître l’adresse à laquelle correspondent les coordonnées. Ce point de terminaison retourne les informations d’adresse d’une coordonnée donnée.

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}

Avec des paramètres facultatifs:

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
query	query	True	number[]	Requête applicable spécifiée sous la forme d’une chaîne séparée par des virgules composée par latitude suivie de longitude, par exemple « 47.641268,-122.125679 ».
allowFreeformNewline	query		boolean	Format des nouvelles lignes dans l’adresse mise en forme. Si la valeur est true, l’adresse contient des lignes nouvelles. Si la valeur est false, les nouvelles lignes sont converties en virgules.
entityType	query		GeographicEntityType	Spécifie le niveau de filtrage effectué sur les zones géographiques. Réduit la recherche des types d’entités géographiques spécifiés, par exemple, renvoyer uniquement une municipalité. La réponse obtenue contient l’ID de géographie, ainsi que le type d’entité mis en correspondance. Si vous fournissez plusieurs entités en tant que liste séparée par des virgules, le point de terminaison retourne la « plus petite entité disponible ». L’ID geometry retourné peut être utilisé pour obtenir la géométrie de cette zone géographique via Obtenir Recherche API Polygone. Les paramètres suivants sont ignorés lorsque entityType est défini : Rubrique nombre returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer	Cap directionnel du véhicule en degrés, pour le déplacement le long d’un segment de route. 0 est Nord, 90 Est et ainsi de suite, les valeurs sont comprises entre -360 et 360. La précision peut inclure jusqu’à une décimale
language	query		string	Langue dans laquelle les résultats de la recherche doivent être retournés. Doit être l’une des balises de langue IETF prises en charge, sans respect de la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée. Pour plus d’informations, consultez Langues prises en charge .
number	query		string	Numéro de rue sous forme de chaîne. Si un numéro est envoyé en même temps que la demande, la réponse peut inclure le côté de la rue (gauche/droite) ainsi qu’une position de décalage pour ce nombre
radius	query		integer	Rayon en mètres à pour que les résultats soient limités à la zone définie
returnMatchType	query		boolean	Incluez des informations sur le type de correspondance du géocodeur obtenu dans la réponse.
returnRoadUse	query		boolean	Propriété booléenne. Pour activer le retour du tableau d’utilisation routière pour les géocodes inverses au niveau de la rue
returnSpeedLimit	query		boolean	Propriété booléenne. Pour activer le retour de la limite de vitesse affichée
roadUse	query		RoadUseType[]	Pour limiter les géocodes inversés à un certain type d’utilisation routière. Le tableau d’utilisations routières pour les géocodes inverses peut être un ou plusieurs de LimitedAccess, Artère, Terminal, Ramp, Rotary, LocalStreet
view	query		LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à l’affichage requis par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN. 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 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	ReverseSearchAddressResult	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, kits 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
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 lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, notre recommandation est d’utiliser l’approche des applications clientes confidentielles pour accéder à Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

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
Dans: header

Exemples

Searches addresses for coordinates 37.337,-121.89

Exemple de requête

HTTP

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

Exemple de réponse

Code d’état:: 200

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

Définitions

Nom	Description
Address	Adresse du résultat
BoundingBoxCompassNotation	Zone englobante de l’emplacement.
Entity	Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GeographicEntityType	Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.
LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à l’affichage requis par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN. Reportez-vous à Vues prises en charge pour plus d’informations et pour voir les vues disponibles.
MatchType	Types de correspondance pour une opération de recherche d’adresses inversées.
QueryType	Type de requête retourné : NEARBY ou NON_NEAR.
ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
ReverseSearchAddressResult	Cet objet est retourné à partir d’un appel d’adresse inversé de Recherche réussi
ReverseSearchAddressResultItem	Objet Result pour une réponse Recherche Address Reverse
RoadUseType	Décrit les utilisations possibles d’une route.
SearchSummary	Objet summary pour une réponse d’API Recherche.

Address

Adresse du résultat

Nom	Type	Description
boundingBox	BoundingBoxCompassNotation	Zone englobante de l’emplacement.
buildingNumber	string	Numéro d’immeuble dans la rue. DEPRECATED, utilisez plutôt streetNumber.
country	string	nom du pays/de la région
countryCode	string	Pays (Remarque : il s’agit d’un code à deux lettres, et non d’un nom de pays/région.)
countryCodeISO3	string	Code de pays ISO alpha-3
countrySecondarySubdivision	string	County
countrySubdivision	string	State or Province
countrySubdivisionCode	string	`countrySubdivisionCode` préfixé par `countryCode` ( countryCode-countrySubdivisionCode ) et le trait d’union forme le code ISO 3166-2. Exemples : TX pour le Texas, SCT pour l’Écosse et ON pour l’Ontario.
countrySubdivisionName	string	Nom complet d’un premier niveau de hiérarchie administrative pays/région. Ce champ apparaît uniquement dans le cas où countrySubdivision est présenté sous une forme abrégée. Pris en charge uniquement pour les États-Unis, le Canada et le Royaume-Uni.
countryTertiarySubdivision	string	Zone nommée
crossStreet	string	Nom de la rue traversée.
extendedPostalCode	string	Code postal étendu (la disponibilité dépend de la région).
freeformAddress	string	Ligne d’adresse mise en forme selon les règles de mise en forme du pays/région d’origine d’un Result, ou dans le cas d’un pays/région, son nom complet de pays/région.
localName	string	Composant d’adresse qui représente le nom d’une zone géographique ou d’une localité qui regroupe plusieurs objets adressables à des fins d’adressage, sans être une unité administrative. Ce champ est utilisé pour générer la `freeformAddress` propriété. `localName` représente la municipalité postale. Selon l’emplacement, `localName` est le nom communément connu d’une ville ou d’une ville. Pour le nom communément connu d’une ville ou d’une ville, utilisez `localName` au lieu de `municipality`.
municipality	string	Ville/ Ville Remarque : `municipality` représente la municipalité résidentielle. Selon l’emplacement, la `municipality` valeur peut différer du nom communément connu d’une ville ou d’une ville. Pour le nom communément connu de la ville ou de la ville, il est suggéré d’utiliser la `localName` valeur à la place de la `municipality` valeur.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Un quartier est une zone géographiquement localisée au sein d’une ville avec des caractéristiques distinctives et des interactions sociales entre les habitants.
postalCode	string	Postal Code / Zip Code
routeNumbers	string[]	Codes utilisés pour identifier sans ambiguïté la rue
street	string	Nom de la rue. DEPRECATED, utilisez streetName à la place.
streetName	string	Nom de la rue.
streetNameAndNumber	string	Nom et numéro de la rue.
streetNumber	string	Numéro d’immeuble dans la rue.

BoundingBoxCompassNotation

Zone englobante de l’emplacement.

Nom	Type	Description
entity	Entity	Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.
northEast	string	Latitude nord-est, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules
southWest	string	Latitude sud-ouest, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules

Entity

Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.

Nom	Type	Description
position	string	Entité de position

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.

GeographicEntityType

Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.

Nom	Type	Description
Country	string	nom du pays/de la région
CountrySecondarySubdivision	string	County
CountrySubdivision	string	State or Province
CountryTertiarySubdivision	string	Zone nommée
Municipality	string	Ville/ Ville
MunicipalitySubdivision	string	Sub / Super City
Neighbourhood	string	Quartier
PostalCodeArea	string	Postal Code / Zip Code

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é

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à l’affichage requis par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN.

Reportez-vous à Vues prises en charge pour plus d’informations et pour voir les vues disponibles.

Nom	Type	Description
AE	string	Émirats Arabes Unis (affichage arabe)
AR	string	Argentine (affichage argentin)
Auto	string	Retourne les données cartographiques correspondant à l’adresse IP de la requête.
BH	string	Bahreïn (affichage arabe)
IN	string	Inde (affichage indien)
IQ	string	Irak (affichage arabe)
JO	string	Jordanie (affichage arabe)
KW	string	Koweït (affichage arabe)
LB	string	Liban (affichage arabe)
MA	string	Maroc (affichage marocain)
OM	string	Oman (affichage arabe)
PK	string	Pakistan (affichage pakistanais)
PS	string	Autorité palestinienne (affichage arabe)
QA	string	Qatar (affichage arabe)
SA	string	Arabie Saoudite (affichage arabe)
SY	string	Syrie (affichage arabe)
Unified	string	Affichage unifié (Autres)
YE	string	Yémen (affichage arabe)

MatchType

Types de correspondance pour une opération de recherche d’adresses inversées.

Nom	Type	Description
AddressPoint	string
HouseNumberRange	string
Street	string

QueryType

Type de requête retourné : NEARBY ou NON_NEAR.

Nom	Type	Description
NEARBY	string	Recherche a été effectué autour d’une certaine latitude et longitude avec un rayon défini
NON_NEAR	string	Recherche a été effectué globalement, sans biaiser à une certaine latitude et longitude, et aucun rayon défini

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.

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

ReverseSearchAddressResult

Cet objet est retourné à partir d’un appel d’adresse inversé de Recherche réussi

Nom	Type	Description
addresses	ReverseSearchAddressResultItem[]	Tableau d’adresses
summary	SearchSummary	Objet summary pour une réponse Recherche Address Reverse

ReverseSearchAddressResultItem

Objet Result pour une réponse Recherche Address Reverse

Nom	Type	Description
address	Address	Adresse du résultat
matchType	MatchType	Informations sur le type de correspondance. Valeurs possibles : AddressPoint HouseNumberRange Rue
position	string	Position de la propriété sous la forme « {latitude},{longitude} »
roadUse	RoadUseType[]	Décrit les utilisations possibles d’une route.

RoadUseType

Décrit les utilisations possibles d’une route.

Nom	Type	Description
Arterial	string
LimitedAccess	string
LocalStreet	string
Ramp	string
Rotary	string
Terminal	string

SearchSummary

Objet summary pour une réponse d’API Recherche.

Nom	Type	Description
fuzzyLevel	integer	Niveau flou maximal requis pour fournir des résultats.
geoBias	LatLongPairAbbreviated	Indication lorsque le moteur de recherche interne a appliqué un biais géospatial pour améliorer le classement des résultats. Dans certaines méthodes, cela peut être affecté en définissant les paramètres lat et lon lorsqu’ils sont disponibles. Dans d’autres cas, elle est purement interne.
limit	integer	Nombre maximal de réponses qui seront retournées
numResults	integer	Nombre de résultats dans la réponse.
offset	integer	Décalage de départ du résultat retourné dans le jeu de résultats complet.
query	string	Paramètre de requête utilisé pour produire ces résultats de recherche.
queryTime	integer	Temps passé à résoudre la requête, en millisecondes.
queryType	QueryType	Type de requête retourné : NEARBY ou NON_NEAR.
totalResults	integer	Nombre total de résultats trouvés.

Partager via