Geolocation - Get IP To Location

Utilize para obter o código de país iso para um determinado endereço IP

A Get IP To Location API é um pedido HTTP GET que, tendo em conta um endereço IP, devolve o código de país iso a partir do qual esse endereço IP está localizado. Os programadores podem utilizar estas informações para bloquear ou alterar determinados conteúdos com base em localizações geográficas a partir das quais a aplicação está a ser vista.

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

Parâmetros do URI

Name Em Necessário Tipo Description
format
path True

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

api-version
query True

string

Número da versão da API Azure Maps.

ip
query True

string

O endereço IP. Tanto O IPv4 como o IPv6 são permitidos.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name Tipo Description
200 OK

IpAddressToLocationResult

OK

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Create uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Successfully retrieve country code from IP address

Sample Request

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

Sample Response

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

Definições

Name Description
CountryRegion

O objeto que contém as informações do país/região.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

IpAddressToLocationResult

Este objeto é devolvido de uma chamada efetuada com êxito à API endereço IP para país/região

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

CountryRegion

O objeto que contém as informações do país/região.

Name Tipo Description
isoCode

string

O código de 2 carateres do Endereço IP (ISO 3166-1) do país ou região. Tenha em atenção que o endereço IP nos intervalos reservados para fins especiais devolverá Nulo para o país/região.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

IpAddressToLocationResult

Este objeto é devolvido de uma chamada efetuada com êxito à API endereço IP para país/região

Name Tipo Description
countryRegion

CountryRegion

O objeto que contém as informações do país/região.

ipAddress

string

O Endereço IP do pedido.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name Tipo Description
json

string

Formato JavaScript Object Notation Data Interchange