Поделиться через


Search - Get Search Address Reverse

Используется для получения адреса и расположения от координат широты и долготы.
API Get Search Address Reverse — это запрос HTTP GET, который возвращает адрес улицы или расположение при указании координат широты и долготы.

Иногда может возникнуть необходимость перевести координату (например, 37.786505, -122.3862) в понятный почтовый адрес человека. Чаще всего это необходимо в приложениях отслеживания, где вы получаете GPS-канал от устройства или ресурса и хотите знать, какой адрес находится координата. Эта конечная точка вернет сведения об адресе для заданной координаты.

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}
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}

Параметры URI

Имя В Обязательно Тип Описание
format
path True

ResponseFormat

Требуемый формат ответа. Значение может быть либо json, либо xml.

api-version
query True

string

Номер версии API Azure Maps.

query
query True

number[]

Применимый запрос, указанный как разделенная запятыми строка, состоящая из широты, за которой следует долгота, например "47.641268,-125679".

allowFreeformNewline
query

boolean

Формат новых линий в отформатированный адрес.

Если значение true, адрес будет содержать новые линии. Если значение false, новые линии будут преобразованы в запятые.

entityType
query

GeographicEntityType

Указывает уровень фильтрации, выполняемый в географических регионах. Сужает поиск указанных типов сущностей geography, например, возвращает только муниципалитет. Полученный ответ будет содержать идентификатор географического региона, а также тип сущности, соответствующий. Если вы предоставляете несколько сущностей в виде разделенного запятыми списка, конечная точка вернет "наименьшую доступную сущность". Возвращаемый идентификатор геометрии можно использовать для получения геометрии этого географического региона с помощью API получения много угольника поиска. Следующие параметры игнорируются при установке entityType:

  • heading
  • число
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
heading
query

integer

minimum: -360
maximum: 360

Направление движения транспортного средства в градусах для перемещения вдоль сегмента дорожной дороги. 0 — Север, 90 — восток и т. д., значения варьируются от -360 до 360. Точность может включать до одного десятичного разряда

language
query

string

Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию.

Дополнительные сведения см. в поддерживаемых языках.

number
query

string

Номер улицы в виде строки. Если число отправляется вместе с запросом, ответ может включать сторону улицы (слева или справа), а также позицию смещения для этого числа.

radius
query

integer

Радиус в метрах для результатов, которые должны быть ограничены определенной областью.

returnMatchType
query

boolean

Включите сведения о типе соответствия геокодера, достигнутого в ответе.

returnRoadUse
query

boolean

Булев. Включение возврата массива использования дорог для обратных геокодов на уровне улицы

returnSpeedLimit
query

boolean

Булев. Включение возврата размещенного ограничения скорости

roadUse
query

RoadUseType[]

Ограничение обратных геокодов определенным типом использования дорог. Массив использования дорог для обратных геокодов может быть одним или несколькими LimitedAccess, Артериальная, Терминал, Пандус, Ротари, LocalStreet

view
query

LocalizedMapView

Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе в отношении сопоставления страны или региона, где доступны карты, изображения и другое содержимое, которое вы авторизованы для доступа через Azure Maps. Пример: view=IN.

Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

Заголовок запроса

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .

Ответы

Имя Тип Описание
200 OK

ReverseSearchAddressResult

ХОРОШО

Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

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 или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Searches addresses for coordinates 37.337,-121.89

Образец запроса

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

Пример ответа

{
  "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"
    }
  ]
}

Определения

Имя Описание
Address

Адрес результата

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

Entity

Источник типа сущности ограничивающего поля. Для обратного геокодирования это всегда равно позиции.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Ответ на ошибку

GeographicEntityType

Тип сущности Geography. Присутствует только в том случае, если entityType был запрошен и доступен.

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".

LocalizedMapView

Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе в отношении сопоставления страны или региона, где доступны карты, изображения и другое содержимое, которое вы авторизованы для доступа через Azure Maps. Пример: view=IN.

Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

MatchType

Типы совпадений для операции поиска обратного адреса.

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

ResponseFormat

Требуемый формат ответа. Значение может быть либо json, либо xml.

ReverseSearchAddressResult

Этот объект возвращается из успешного обратного вызова адреса поиска

ReverseSearchAddressResultItem

Результирующий объект для обратного ответа "Адрес поиска"

RoadUseType

Описывает возможное использование дороги.

SearchSummary

Сводный объект для ответа API поиска.

Address

Адрес результата

Имя Тип Описание
boundingBox

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

buildingNumber

string

Номер здания на улице. Вместо этого используйте streetNumber.

country

string

имя страны или региона

countryCode

string

Страна (примечание. Это двухбуквенный код, а не имя страны или региона.)

countryCodeISO3

string

Код страны ISO альфа-3

countrySecondarySubdivision

string

Округ

countrySubdivision

string

Штат или провинция

countrySubdivisionCode

string

countrySubdivisionCode префиксом countryCode (countryCode-countrySubdivisionCode) и дефисом формирует код ISO 3166-2. Примеры: TX для Техаса, SCT для Шотландии и ON для Онтарио.

countrySubdivisionName

string

Полное имя первой административной иерархии страны или региона. Это поле отображается только в том случае, если countrySubdivision представлен в сокращенной форме. Поддерживается только для США, Канады и Соединенного Королевства.

countryTertiarySubdivision

string

Именованной области

crossStreet

string

Имя улицы, пересекаемой.

extendedPostalCode

string

Расширенный почтовый индекс (доступность зависит от региона).

freeformAddress

string

Адресная строка, отформатированная в соответствии с правилами форматирования страны или региона источника результата или в случае страны или региона, его полное имя страны или региона.

localName

string

Компонент адреса, представляющий имя географической области или локальности, которая группирует несколько адресных объектов для решения задач, не являясь административной единицей. Это поле используется для создания свойства freeformAddress. localName представляет почтовый муниципалитет. В зависимости от расположения, localName является общим именем города или города. Для известного имени города или города используйте localName вместо municipality.

municipality

string

Город / город
Примечание. municipality представляет жилой муниципалитет. В зависимости от расположения значение municipality может отличаться от общего имени города или города. Для известного имени города или города предполагается, что localName значение будет использоваться вместо значения municipality.

municipalitySubdivision

string

Sub / Super City

neighbourhood

string

Район является географически локализованным районом в городе или городе с отличительными характеристиками и социальным взаимодействием между жителями.

postalCode

string

Почтовый индекс / почтовый индекс

routeNumbers

string[]

Коды, используемые для однозначной идентификации улицы

street

string

Имя улицы. Вместо этого используйте streetName.

streetName

string

Имя улицы.

streetNameAndNumber

string

Имя и номер улицы.

streetNumber

string

Номер здания на улице.

BoundingBoxCompassNotation

Ограничивающий прямоугольник расположения.

Имя Тип Описание
entity

Entity

Источник типа сущности ограничивающего поля. Для обратного геокодирования это всегда равно позиции.

northEast

string

Северо-восточная широта, долгота ограничивающего прямоугольника как запятые разделенные запятыми плавают

southWest

string

Юго-западная широта, долгота координаты ограничивающего прямоугольника как запятые разделенные запятыми плавают

Entity

Источник типа сущности ограничивающего поля. Для обратного геокодирования это всегда равно позиции.

Значение Описание
position

Позиция сущности

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

GeographicEntityType

Тип сущности Geography. Присутствует только в том случае, если entityType был запрошен и доступен.

Значение Описание
Country

имя страны или региона

CountrySecondarySubdivision

Округ

CountrySubdivision

Штат или провинция

CountryTertiarySubdivision

Именованной области

Municipality

Город / город

MunicipalitySubdivision

Sub / Super City

Neighbourhood

Округа

PostalCodeArea

Почтовый индекс / почтовый индекс

LatLongPairAbbreviated

Расположение, представленное в виде широты и долготы, используя короткие имена "lat" & "lon".

Имя Тип Описание
lat

number (double)

Свойство Latitude

lon

number (double)

Свойство Долготы

LocalizedMapView

Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, в том числе в отношении сопоставления страны или региона, где доступны карты, изображения и другое содержимое, которое вы авторизованы для доступа через Azure Maps. Пример: view=IN.

Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

Значение Описание
AE

Объединенные Арабские Эмираты (арабское представление)

AR

Аргентина (Аргентинский вид)

Auto

Возвращает данные карты на основе IP-адреса запроса.

BH

Бахрейн (арабский вид)

IN

Индия (индийский вид)

IQ

Ирак (арабское представление)

JO

Иордания (арабское представление)

KW

Кувейт (арабский вид)

LB

Ливан (арабский вид)

MA

Марокко (Марокко)

OM

Оман (арабский вид)

PK

Пакистан (пакистанский вид)

PS

Палестинский орган (арабское представление)

QA

Катар (арабский вид)

SA

Саудовская Аравия (арабское представление)

SY

Сирия (арабский вид)

Unified

Унифицированное представление (другие)

YE

Йемен (арабское представление)

MatchType

Типы совпадений для операции поиска обратного адреса.

Значение Описание
AddressPoint
HouseNumberRange
Street

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

Значение Описание
NEARBY

Поиск был выполнен вокруг определенной широты и долготы с определенным радиусом

NON_NEAR

Поиск был выполнен глобально, без предвзятости к определенной широте и долготе, и никакого определенного радиуса

ResponseFormat

Требуемый формат ответа. Значение может быть либо json, либо xml.

Значение Описание
json

формат обмена данными для объектов JavaScript

xml

расширяемый язык разметки

ReverseSearchAddressResult

Этот объект возвращается из успешного обратного вызова адреса поиска

Имя Тип Описание
addresses

ReverseSearchAddressResultItem[]

Массив адресов

summary

SearchSummary

Объект сводки для обратного ответа "Адрес поиска"

ReverseSearchAddressResultItem

Результирующий объект для обратного ответа "Адрес поиска"

Имя Тип Описание
address

Address

Адрес результата

matchType

MatchType

Сведения о типе соответствия.

Одно из:

  • AddressPoint
  • HouseNumberRange
  • Улица
position

string

Свойство Position в виде "{широта},{долгота}"

roadUse

RoadUseType[]

Описывает возможное использование дороги.

RoadUseType

Описывает возможное использование дороги.

Значение Описание
Arterial
LimitedAccess
LocalStreet
Ramp
Rotary
Terminal

SearchSummary

Сводный объект для ответа API поиска.

Имя Тип Описание
fuzzyLevel

integer

Максимальный нечеткий уровень, необходимый для предоставления результатов.

geoBias

LatLongPairAbbreviated

Указывает, когда внутренняя поисковая система применила геопространственный предвзятость для улучшения ранжирования результатов. В некоторых методах это может повлиять, задав параметры lat и lon, где они доступны. В других случаях это чисто внутренний.

limit

integer

Максимальное количество возвращаемых ответов

numResults

integer

Количество результатов в ответе.

offset

integer

Начальная смещение возвращаемых результатов в полном наборе результатов.

query

string

Параметр запроса, используемый для создания этих результатов поиска.

queryTime

integer

Время, затраченное на разрешение запроса в миллисекундах.

queryType

QueryType

Тип возвращаемого запроса: NEARBY или NON_NEAR.

totalResults

integer

Общее количество найденных результатов.