Search - Get Reverse Geocoding
Используется для получения адреса улицы и информации о местоположении по координатам долготы и широты.
API Get Reverse Geocoding — это запрос HTTP GET, используемый для перевода координат (например, 37.786505, -122.3862) в понятный почтовый адрес человека. Полезно в отслеживании приложений, где вы получаете GPS-канал от устройства или ресурса и хотите знать адрес, связанный с координатами. Эта конечная точка вернет сведения об адресе для заданной координаты.
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates={coordinates}
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Номер версии API Azure Maps. |
|
coordinates
|
query | True |
number[] |
Координаты расположения, которое требуется отменить геокод. Пример: координаты &=lon,lat |
|
result
|
query |
Укажите типы сущностей, которые требуется в ответе. Будут возвращены только указанные типы. Если точка не может быть сопоставлена с указанными типами сущностей, в ответе не возвращаются сведения о расположении. Значение по умолчанию — это все возможные сущности. Разделенный запятыми список типов сущностей, выбранных из следующих параметров.
Эти типы сущностей упорядочены из наиболее конкретной сущности в наименьшую конкретную сущность. При обнаружении сущностей нескольких типов сущностей возвращается только самая конкретная сущность. Например, если вы указали Address и AdminDistrict1 как типы сущностей и сущности для обоих типов, в ответе возвращаются только сведения об сущности Address. |
||
|
view
|
query |
string |
Строка, представляющая код региона илистраны ISO 3166-1 Альфа-2. Это изменит геополитические спорные границы и метки, чтобы выровняться с указанным регионом пользователя. По умолчанию параметр View имеет значение Auto, даже если он не определен в запросе. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Azure AD. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Дополнительные сведения об использовании безопасности Microsoft Entra ID в Azure Maps см. в статье Управление проверкой подлинности в Azure Maps. |
|
| Accept-Language |
string |
Язык, в котором должны быть возвращены результаты поиска. Дополнительные сведения см. в поддерживаемых языках. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
ХОРОШО Media Types: "application/geo+json" |
|
| Other Status Codes |
Произошла непредвиденная ошибка. Media Types: "application/geo+json" |
Безопасность
AADToken
Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.
Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.
Замечание
- Для этого определения безопасности требуется использовать заголовок
x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами. -
Authorization URLзависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra. - Управление доступом на основе ролей Azure настраивается на основе плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
- Использование веб-пакета SDK для Azure Maps
позволяет настроить приложение на основе конфигурации для нескольких вариантов использования. - Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, подготовленный при создании ресурса Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложению разрешен доступ ко всем REST API. Другими словами, они в настоящее время могут рассматриваться как главные ключи учетной записи, для которой они выданы.
Для общедоступных приложений мы рекомендуем использовать доступ к REST API Azure Maps на сервере, где этот ключ можно безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
Search point -122.138681, 47.630358
Образец запроса
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates=-122.138681,47.630358
Пример ответа
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King County",
"shortName": "King Co."
}
],
"formattedAddress": "15127 NE 24th St, Redmond, Washington 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"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
]
}
]
}
Определения
| Имя | Описание |
|---|---|
| Address |
Адрес результата |
|
Admin |
Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе. |
|
Calculation |
Метод, используемый для вычисления точки геокода. |
|
Confidence |
Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении. Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано. |
|
Country |
|
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Ответ на ошибку |
|
Feature |
Тип объекта FeatureCollection должен быть FeatureCollection. |
|
Features |
|
|
Feature |
Тип компонента должен быть компонентом. |
|
Geocode |
Коллекция точек геокода, отличающихся от способа их вычисления и их предлагаемого использования. |
|
Geocoding |
Этот объект возвращается из успешного вызова Geocoding |
|
Geo |
Допустимый тип геометрии |
| Intersection |
Адрес результата. |
|
Match |
Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе. Например, геокодированное расположение с кодами соответствия Аналогичным образом геокодированное расположение с кодами соответствия Возможные значения:
|
| Properties | |
|
Reverse |
Укажите типы сущностей, которые требуется в ответе. Будут возвращены только указанные типы. Если точка не может быть сопоставлена с указанными типами сущностей, в ответе не возвращаются сведения о расположении. Значение по умолчанию — это все возможные сущности. Разделенный запятыми список типов сущностей, выбранных из следующих параметров.
Эти типы сущностей упорядочены из наиболее конкретной сущности в наименьшую конкретную сущность. При обнаружении сущностей нескольких типов сущностей возвращается только самая конкретная сущность. Например, если вы указали Address и AdminDistrict1 как типы сущностей и сущности для обоих типов, в ответе возвращаются только сведения об сущности Address. |
|
Usage |
Лучше всего использовать для точки геокода.
Каждая точка геокода определяется как точка |
Address
Адрес результата
| Имя | Тип | Описание |
|---|---|---|
| addressLine |
string |
Адресная линия, содержащая имя и номер улицы |
| adminDistricts |
Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе. |
|
| countryRegion | ||
| formattedAddress |
string |
Свойство Formatted Address |
| intersection |
Адрес результата. |
|
| locality |
string |
Свойство locality |
| neighborhood |
string |
имущество по соседству |
| postalCode |
string |
Свойство Почтового кода |
| streetName |
string |
Название улицы из formattedAddress |
| streetNumber |
string |
Номер на улице, если таковой имеется, из formattedAddress |
AdminDistricts
Имя подразделения в стране или регионе для адреса. Обычно этот элемент рассматривается как первое административное подразделение порядка, но в некоторых случаях он также содержит второй, третий или четвертый отдел порядка в стране, зависимости или регионе.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя соответствующего поля adminDistrict, For adminDistrict[0], это может быть полное имя штата, например Вашингтон, For adminDistrict[1], это может быть полное имя округа |
| shortName |
string |
Короткое имя соответствующего поля adminDistrict для adminDistrict[0], это может быть короткое имя штата, например WA, For adminDistrict[1], это может быть короткое имя округа. |
CalculationMethodEnum
Метод, используемый для вычисления точки геокода.
| Значение | Описание |
|---|---|
| Interpolation |
Точка геокодирования была сопоставлена с точкой на дороге с помощью интерполяции. |
| InterpolationOffset |
Точка геокодирования была сопоставлена с точкой на дороге с помощью интерполяции с дополнительным смещением для смещения точки в сторону улицы. |
| Parcel |
Точка геокодирования была сопоставлена с центром участка. |
| Rooftop |
Точка геокодирования была сопоставлена с крышей здания. |
ConfidenceEnum
Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении.
Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано.
| Значение | Описание |
|---|---|
| High |
Если достоверность установлена на Если запрос включает местоположение или представление, то рейтинг может измениться соответствующим образом. Например, запрос местоположения для "Париж" с уверенностью возвращает "Париж, Франция" и "Париж, Техас". |
| Medium |
В некоторых ситуациях возвращенное совпадение может не совпадать с информацией, предоставленной в запросе. Например, в запросе может быть указана адресная информация, а служба геокодирования может сопоставить только почтовый индекс. В этом случае, если служба геокодирования имеет уверенность в том, что почтовый индекс соответствует данным, то устанавливается значение достоверности Если информация о расположении в запросе неоднозначна и нет дополнительных сведений для ранжирования местоположений (например, местоположения пользователя или относительная важность расположения), достоверность устанавливается в значение Если информация о местоположении в запросе не предоставляет достаточной информации для геокодирования конкретного местоположения, может быть возвращено менее точное значение местоположения, а достоверность устанавливается в |
| Low |
CountryRegion
| Имя | Тип | Описание |
|---|---|---|
| ISO |
string |
ISO страны или региона |
| name |
string |
имя страны или региона |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительные сведения. |
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
FeatureCollectionEnum
Тип объекта FeatureCollection должен быть FeatureCollection.
| Значение | Описание |
|---|---|
| FeatureCollection |
FeaturesItem
| Имя | Тип | Описание |
|---|---|---|
| bbox |
number[] (double) |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
| geometry |
Допустимый тип геометрии |
|
| id |
string |
Идентификатор возвращаемой функции |
| properties | ||
| type |
Тип компонента должен быть компонентом. |
FeatureTypeEnum
Тип компонента должен быть компонентом.
| Значение | Описание |
|---|---|
| Feature |
GeocodePoints
Коллекция точек геокода, отличающихся от способа их вычисления и их предлагаемого использования.
| Имя | Тип | Описание |
|---|---|---|
| calculationMethod |
Метод, используемый для вычисления точки геокода. |
|
| geometry |
Допустимый тип геометрии |
|
| usageTypes |
Лучше всего использовать для точки геокода.
Каждая точка геокода определяется как точка |
GeocodingResponse
Этот объект возвращается из успешного вызова Geocoding
| Имя | Тип | Описание |
|---|---|---|
| features | ||
| nextLink |
string |
Ссылка на следующую страницу возвращаемых функций. Если это последняя страница, это поле не отображается. |
| type |
Тип объекта FeatureCollection должен быть FeatureCollection. |
GeoJsonPoint
Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.
| Имя | Тип | Описание |
|---|---|---|
| bbox |
number[] (double) |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
Указывает тип |
Intersection
Адрес результата.
| Имя | Тип | Описание |
|---|---|---|
| baseStreet |
string |
Первичная улица для расположения. |
| displayName |
string |
Полное имя пересечения. |
| intersectionType |
string |
Тип пересечения. |
| secondaryStreet1 |
string |
Первая пересекающаяся улица. |
| secondaryStreet2 |
string |
Если таковые есть, второй пересекающийся улица. |
MatchCodesEnum
Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе.
Например, геокодированное расположение с кодами соответствия Good и Ambiguous означает, что для сведений о расположении было найдено несколько расположений геокода, а служба геокодов не искала совпадения.
Аналогичным образом геокодированное расположение с кодами соответствия Ambiguous и UpHierarchy подразумевает, что расположение геокода не удалось найти, которое соответствовало всем предоставленным сведениям о расположении, поэтому служба геокодов должна была выполнять поиск по иерархии и находить несколько совпадений на этом уровне. Пример Ambiguous и результата UpHierarchy заключается в предоставлении полных сведений об адресе, но служба геокодов не может найти совпадение для адреса улицы и вместо этого возвращает сведения для нескольких значений RoadBlock.
Возможные значения:
Good: расположение имеет только одно совпадение или все возвращенные совпадения считаются сильными. Например, запрос на нью-йорк возвращает несколько хороших совпадений.
Ambiguous: расположение является одним из возможных совпадений. Например, когда вы запрашиваете адрес улицы 128 Main St., ответ может вернуть два расположения для 128 Северо-Главной и 128 Южный Главный Санкт, так как недостаточно информации, чтобы определить, какой вариант выбрать.
UpHierarchy: расположение представляет перемещение по географической иерархии. Это происходит, когда совпадение для запроса расположения не найдено, поэтому возвращается менее точный результат. Например, если не удается найти совпадение для запрошенного адреса, может быть возвращен код соответствия UpHierarchy с типом сущности RoadBlock.
| Значение | Описание |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| Имя | Тип | Описание |
|---|---|---|
| address |
Адрес результата |
|
| confidence |
Уровень уверенности, что результат географического расположения соответствует. Используйте это значение с кодом соответствия, чтобы определить более полную информацию о совпадении. Достоверность геокодированного расположения основана на многих факторах, включая относительную важность геокодированного расположения и расположения пользователя, если указано. |
|
| geocodePoints |
Коллекция точек геокода, отличающихся от способа их вычисления и их предлагаемого использования. |
|
| matchCodes |
Одно или несколько совпадающих значений кода, представляющих уровень геокодирования для каждого расположения в ответе. Например, геокодированное расположение с кодами соответствия Аналогичным образом геокодированное расположение с кодами соответствия Возможные значения:
|
|
| type |
string |
Одно из:
|
ReverseGeocodingResultTypeEnum
Укажите типы сущностей, которые требуется в ответе. Будут возвращены только указанные типы. Если точка не может быть сопоставлена с указанными типами сущностей, в ответе не возвращаются сведения о расположении. Значение по умолчанию — это все возможные сущности. Разделенный запятыми список типов сущностей, выбранных из следующих параметров.
- Адрес
- Соседство
- Заполненное место
- Postcode1
- AdminDivision1
- AdminDivision2
- СтранаРегион
Эти типы сущностей упорядочены из наиболее конкретной сущности в наименьшую конкретную сущность. При обнаружении сущностей нескольких типов сущностей возвращается только самая конкретная сущность. Например, если вы указали Address и AdminDistrict1 как типы сущностей и сущности для обоих типов, в ответе возвращаются только сведения об сущности Address.
| Значение | Описание |
|---|---|
| Address | |
| Neighborhood | |
| PopulatedPlace | |
| Postcode1 | |
| AdminDivision1 | |
| AdminDivision2 | |
| CountryRegion |
UsageTypeEnum
Лучше всего использовать для точки геокода.
Каждая точка геокода определяется как точка Route, точка Display или оба.
Используйте Route точки, если вы создаете маршрут к расположению. Используйте Display точки, если отображается расположение на карте. Например, если расположение является парком, точка Route может указать вход в парк, где можно войти с автомобилем, и Display точка может быть точкой, которая указывает центр парка.
| Значение | Описание |
|---|---|
| Display | |
| Route |