Search - Get Search Address Reverse Cross Street
Utilisez pour obtenir des informations sur l’emplacement des 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 en fonction 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 humaine compréhensible. 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 des informations sur les rues 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 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 ». |
heading
|
query |
integer |
Le cap directionnel du véhicule en degrés, pour le déplacement le long d’un segment de route. 0 est nord, 90 est 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, ne respectant pas 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 |
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 pays/une région spécifique 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/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/de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris 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é à ê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 |
Ok |
|
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é 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 ressource 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 . - est
Authorization URL
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, cli, kits SDK Azure ou 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, nous vous recommandons 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 Répertorier les SAP 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 précis à l’expiration, au taux et à la ou les régions d’utilisation du 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 Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.
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 |
Cadre englobant de l’emplacement. |
Entity |
Source du 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 |
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ». |
Localized |
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. |
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 inversé d’adresse Recherche réussi |
Reverse |
Objet Result pour une réponse Recherche Address Reverse Cross Street |
Search |
Objet summary pour une réponse d’API Recherche. |
Address
Adresse du résultat
Nom | Type | Description |
---|---|---|
boundingBox |
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 |
|
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 |
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 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
Cadre englobant de l’emplacement.
Nom | Type | Description |
---|---|---|
entity |
Source du 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 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 du type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position.
Nom | Type | Description |
---|---|---|
position |
string |
Entité 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 |
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
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) |
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 |
|
xml |
string |
ReverseSearchCrossStreetAddressResult
Cet objet est retourné à partir d’un appel crossstreet inversé d’adresse Recherche réussi
Nom | Type | Description |
---|---|---|
addresses |
Tableau d’adresses |
|
summary |
Objet summary pour une réponse Recherche Address Reverse Cross Street |
ReverseSearchCrossStreetAddressResultItem
Objet Result pour une réponse Recherche Address Reverse Cross Street
Nom | Type | Description |
---|---|---|
address |
Adresse du résultat |
|
position |
string |
Position de la propriété sous la forme « {latitude},{longitude} » |
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 |
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 |
Type de requête retourné : NEARBY ou NON_NEAR. |
|
totalResults |
integer |
Nombre total de résultats trouvés. |