Geolocation - Get IP To Location

Referencia

Servicio:: Maps

Versión de la API:: 1.0

Use para obtener el código de país ISO para una dirección IP determinada.

La Get IP To Location API es una solicitud HTTP GET que, dada una dirección IP, devuelve el código de país ISO desde el que se encuentra esa dirección IP. Los desarrolladores pueden usar esta información para bloquear o modificar cierto contenido en función de ubicaciones geográficas desde las que se está viendo la aplicación.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.
api-version	query	True	string	Número de versión de la API de Azure Maps.
ip	query	True	string	Dirección IP. Se permiten IPv4 e IPv6.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de id. de Microsoft Entra en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	IpAddressToLocationResult	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en rol de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre la plataforma de identidad de Microsoft, consulte Introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Successfully retrieve country code from IP address

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
CountryRegion	Objeto que contiene la información de país o región.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
IpAddressToLocationResult	Este objeto se devuelve de una llamada correcta a la dirección IP a la API de país o región.
JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.

CountryRegion

Objeto que contiene la información de país o región.

Nombre	Tipo	Description
isoCode	string	El código de 2 caracteres de la dirección IP (ISO 3166-1) del país o región. Tenga en cuenta que la dirección IP de los intervalos reservados para fines especiales devolverá Null para el país o región.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IpAddressToLocationResult

Este objeto se devuelve de una llamada correcta a la dirección IP a la API de país o región.

Nombre	Tipo	Description
countryRegion	CountryRegion	Objeto que contiene la información de país o región.
ipAddress	string	Dirección IP de la solicitud.

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript

Compartir a través de