Geolocation - Get IP To Location

Ссылка

Служба:: Maps

Версия API:: 1.0

Используйте для получения кода страны ISO для заданного IP-адреса.

Get IP To Location API — это HTTP-запросGET, который при указании IP-адреса возвращает код страны ISO, из которой находится этот IP-адрес. Разработчики могут использовать эти сведения для блокировки или изменения определенного содержимого в зависимости от географических расположений, из которых просматривается приложение.

GET https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0&ip={ip}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.
api-version	query	True	string	Номер версии API Azure Maps
ip	query	True	string	IP-адрес. Разрешены протоколы IPv4 и IPv6.

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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Идентификатора Microsoft Entra. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи плоскости управления Azure Maps. Инструкции по использованию безопасности Microsoft Entra ID в Azure Maps см. в следующих статьях .

Ответы

Имя	Тип	Описание
200 OK	IpAddressToLocationResult	ОК
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, пакетов AZURE SDK или REST API.

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successfully retrieve country code from IP address

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

HTTP

GET https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0&ip=2001:4898:80e8:b::189

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

Код состояния:: 200

{
  "countryRegion": {
    "isoCode": "US"
  },
  "ipAddress": "2001:4898:80e8:b::189"
}

Определения

Имя	Описание
CountryRegion	Объект , содержащий сведения о стране или регионе.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
IpAddressToLocationResult	Этот объект возвращается при успешном вызове IP-адреса к API страны или региона.
JsonFormat	Требуемый формат ответа. Поддерживается только формат `json`.

CountryRegion

Объект , содержащий сведения о стране или регионе.

Имя	Тип	Описание
isoCode	string	Двухзначный код IP-адреса (ISO 3166-1) страны или региона. Обратите внимание, что IP-адрес в диапазонах, зарезервированных для специального назначения, возвращает значение NULL для страны или региона.

ErrorAdditionalInfo

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

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

Имя	Тип	Описание
error	ErrorDetail	Объект error.

IpAddressToLocationResult

Этот объект возвращается при успешном вызове IP-адреса к API страны или региона.

Имя	Тип	Описание
countryRegion	CountryRegion	Объект , содержащий сведения о стране или регионе.
ipAddress	string	IP-адрес запроса.

JsonFormat

Требуемый формат ответа. Поддерживается только формат json.

Имя	Тип	Описание
json	string	Формат обмена данными нотации объектов JavaScript

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