Geolocation - Get IP To Location
Se usa para obtener el código ISO de país o región para una dirección IP determinada.
La Get IP To Location API es una solicitud HTTP GET que devuelve el código ISO de país o región para una dirección IP determinada. Los desarrolladores pueden usar esta información para bloquear o modificar contenido en función de la ubicación geográfica desde la que se accede a 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 |
Formato deseado de la respuesta. Solo se admite |
|
|
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 |
Indica la cuenta destinada a su uso con el modelo de seguridad de identificador de Microsoft Entra. Este identificador único para la cuenta de Azure Maps se puede obtener de la API de cuenta del plano de administración de Azure Maps. Para obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se realizó correctamente. El recurso se ha recuperado y se ha incluido en el cuerpo del mensaje. |
|
| Other Status Codes |
Error inesperado. |
Seguridad
AADToken
Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles 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 a través de un rol integrado o de 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 modelar 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 encabezado para indicar a qué recurso de
x-ms-client-idAzure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.
El 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 a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
* El uso de 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 Creación de 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.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque 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 crea un token de firma de acceso compartido 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, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a 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 controle 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 cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Successfully retrieve country/region code from IP address
Solicitud de ejemplo
GET https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0&ip=2001:4898:80e8:b::189
Respuesta de muestra
{
"countryRegion": {
"isoCode": "US"
},
"ipAddress": "2001:4898:80e8:b::189"
}
Definiciones
| Nombre | Description |
|---|---|
|
Country |
Objeto que contiene la información de país o región. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta de error |
|
Ip |
Este objeto se devuelve desde una llamada correcta a la dirección IP a la API de país o región. |
|
Json |
Formato deseado de la respuesta. Solo se admite |
CountryRegion
Objeto que contiene la información de país o región.
| Nombre | Tipo | Description |
|---|---|---|
| isoCode |
string |
El código de país o región de 2 caracteres de la dirección IP (ISO 3166-1). Tenga en cuenta que las direcciones IP de los intervalos reservados para fines especiales devolverán Null para el país o la 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 |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
IpAddressToLocationResult
Este objeto se devuelve desde una llamada correcta a la dirección IP a la API de país o región.
| Nombre | Tipo | Description |
|---|---|---|
| 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 json formato.
| Valor | Description |
|---|---|
| json |
el formato de intercambio de datos de notación de objetos JavaScript |