Search - Get Search Address Reverse Cross Street
Permet d’obtenir des informations sur l’emplacement inter-rues à partir des coordonnées de latitude et de longitude.
L’API Get Search Address Reverse Cross Street
est une requête HTTP GET
qui retourne la rue la plus proche lorsqu’elle reçoit des coordonnées de latitude et de longitude. Il peut arriver que vous deviez traduire une coordonnée (exemple : 37.786505, -122.3862) en une rue croisée compréhensible par l’homme. Le plus souvent, cela est nécessaire dans le suivi des applications où vous recevez un flux GPS de l’appareil ou de l’élément multimédia et souhaitez savoir quelle adresse se trouve la coordonnée.
Ce point de terminaison retourne les informations sur les rues croisées pour une coordonnée donnée.
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}&limit={limit}&heading={heading}&radius={radius}&language={language}&view={view}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
format
|
path | True |
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 en tant que chaîne séparée par des virgules composée par latitude suivie de longitude, par exemple « 47,641268,-1222.125679 ». |
heading
|
query |
integer minimum: -360maximum: 360 |
Le titre directionnel du véhicule en degrés, pour se déplacer le long d’un segment de route. 0 est Nord, 90 est Est et ainsi de suite, les valeurs vont de -360 à 360. La précision peut inclure jusqu’à une décimale |
|
language
|
query |
string |
Langue dans laquelle les résultats de recherche doivent être retournés. Doit être l’une des balises de langage 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. |
|
limit
|
query |
integer minimum: 1maximum: 100 |
Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100 |
|
radius
|
query |
integer |
Rayon en mètres pour que les résultats soient limités à la zone définie |
|
view
|
query |
Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées. 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 à la vue requise par le pays/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », 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 le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de 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/de la région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Spécifie le compte destiné à l’utilisation 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 de plan de gestion Azure Maps. Pour utiliser la sécurité microsoft Entra ID dans Azure Maps, consultez les articles suivants pour obtenir des conseils. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
D’ACCORD |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
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.
Remarque
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-id
pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps. - La
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 de l'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 la configuration basée sur la configuration d’une application 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 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:
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 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
Search address of the nearest intersection/crossroad
Exemple de requête
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/json?api-version=1.0&query=37.337,-121.89
Exemple de réponse
{
"summary": {
"numResults": 1,
"queryTime": 41
},
"addresses": [
{
"address": {
"streetName": "East Santa Clara Street & North 2nd Street",
"crossStreet": "East Santa Clara Street",
"municipalitySubdivision": "San Jose, Downtown San Jose",
"municipality": "San Jose",
"countrySecondarySubdivision": "Santa Clara",
"countryTertiarySubdivision": "San Jose",
"countrySubdivisionCode": "CA",
"postalCode": "95113",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
"countrySubdivisionName": "California"
},
"position": "37.33666,-121.88951"
}
]
}
Définitions
Nom | Description |
---|---|
Address |
Adresse du résultat |
Bounding |
Zone englobante de l’emplacement. |
Entity |
Source de type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Lat |
Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'. |
Localized |
Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées. 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 à la vue requise par le pays/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », 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 le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de 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/de la région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles. |
Query |
Type de requête retourné : NEARBY ou NON_NEAR. |
Response |
Format souhaité de la réponse. La valeur peut être json ou xml. |
Reverse |
Cet objet est retourné à partir d’un appel CrossStreet inverse de l’adresse de recherche réussie |
Reverse |
Objet Result pour une réponse cross street inversée de l’adresse de recherche |
Search |
Objet résumé pour une réponse d’API de recherche. |
Address
Adresse du résultat
Nom | Type | Description |
---|---|---|
boundingBox |
Zone englobante de l’emplacement. |
|
buildingNumber |
string |
Numéro de bâtiment sur la rue. DÉCONSEILLÉ, 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 pays ISO alpha-3 |
countrySecondarySubdivision |
string |
Comté |
countrySubdivision |
string |
État ou province |
countrySubdivisionCode |
string |
|
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 forme abrégée. Uniquement pris en charge pour les États-Unis, le Canada et le Royaume-Uni. |
countryTertiarySubdivision |
string |
Zone nommée |
crossStreet |
string |
Nom de la rue en cours de traversée. |
extendedPostalCode |
string |
Code postal étendu (la disponibilité dépend de la région). |
freeformAddress |
string |
Ligne d’adresse mise en forme en fonction des règles de mise en forme du pays/de la région d’origine d’un résultat, ou dans le cas d’un pays/région, son nom de pays/région complet. |
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 propriété |
municipality |
string |
Ville / Ville |
municipalitySubdivision |
string |
Sub / Super City |
neighbourhood |
string |
Un quartier est une zone géographiquement localisée au sein d’une ville ou 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. DÉCONSEILLÉ, utilisez streetName à la place. |
streetName |
string |
Nom de la rue. |
streetNameAndNumber |
string |
Nom et numéro de la rue. |
streetNumber |
string |
Numéro de bâtiment sur la rue. |
BoundingBoxCompassNotation
Zone englobante de l’emplacement.
Nom | Type | Description |
---|---|---|
entity |
Source de type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position. |
|
northEast |
string |
Latitude nord-est, coordonnée de longitude du cadre englobant sous forme de virgules séparées par des virgules |
southWest |
string |
Latitude sud-ouest, coordonnée de longitude du cadre englobant sous forme de virgules flottantes séparées par des virgules |
Entity
Source de type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position.
Valeur | Description |
---|---|
position |
Position de l’entité |
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émentaire. |
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. |
LatLongPairAbbreviated
Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.
Nom | Type | Description |
---|---|---|
lat |
number (double) |
Latitude, propriété |
lon |
number (double) |
Longitude, propriété |
LocalizedMapView
Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées. 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 à la vue requise par le pays/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », 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 le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de 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/de la région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN.
Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles.
Valeur | Description |
---|---|
AE |
Émirats arabes unis (vue arabe) |
AR |
Argentine (vue argentine) |
Auto |
Retournez les données cartographiques en fonction de l’adresse IP de la requête. |
BH |
Bahreïn (vue arabe) |
IN |
Inde (Vue indienne) |
IQ |
Irak (vue arabe) |
JO |
Jordanie (vue arabe) |
KW |
Koweït (vue arabe) |
LB |
Liban (vue arabe) |
MA |
Maroc (vue marocaine) |
OM |
Oman (vue arabe) |
PK |
Pakistan (vue pakistanaise) |
PS |
Autorité palestinienne (vue arabe) |
QA |
Qatar (vue arabe) |
SA |
Arabie saoudite (vue arabe) |
SY |
Syrie (vue arabe) |
Unified |
Affichage unifié (autres) |
YE |
Yémen (vue arabe) |
QueryType
Type de requête retourné : NEARBY ou NON_NEAR.
Valeur | Description |
---|---|
NEARBY |
La recherche a été effectuée autour d’une certaine latitude et longitude avec un rayon défini |
NON_NEAR |
La recherche a été effectuée 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.
Valeur | Description |
---|---|
json | |
xml |
ReverseSearchCrossStreetAddressResult
Cet objet est retourné à partir d’un appel CrossStreet inverse de l’adresse de recherche réussie
Nom | Type | Description |
---|---|---|
addresses |
Tableau d’adresses |
|
summary |
Objet summary pour une réponse cross street inversée de l’adresse de recherche |
ReverseSearchCrossStreetAddressResultItem
Objet Result pour une réponse cross street inversée de l’adresse de recherche
Nom | Type | Description |
---|---|---|
address |
Adresse du résultat |
|
position |
string |
Propriété Position sous la forme « {latitude},{longitude} » |
SearchSummary
Objet résumé pour une réponse d’API de recherche.
Nom | Type | Description |
---|---|---|
fuzzyLevel |
integer |
Niveau flou maximal requis pour fournir les résultats. |
geoBias |
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, le cas échéant. Dans d’autres cas, il 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 des résultats retournés 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 |
Type de requête retourné : NEARBY ou NON_NEAR. |
|
totalResults |
integer |
Nombre total de résultats trouvés. |