Geolocation - Get IP To Location

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para obter o código de país ISO para um determinado endereço IP

A Get IP To Location API é uma solicitação HTTP GET que, dado um endereço IP, retorna o código de país ISO do qual o endereço IP está localizado. Os desenvolvedores podem usar essas informações para bloquear ou alterar determinado conteúdo com base em locais geográficos dos quais o aplicativo está sendo exibido.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.
api-version	query	True	string	Número de versão da API de Mapas Azure.
ip	query	True	string	O endereço IP. IPv4 e IPv6 são permitidos.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança do Microsoft Entra ID no Azure Mapas, confira os artigos a seguir para obter diretrizes .

Respostas

Nome	Tipo	Description
200 OK	IpAddressToLocationResult	OK
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Estes são os Fluxos do Microsoft Entra OAuth 2.0 . Quando emparelhado com o controle de acesso baseado em função do Azure , ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte Visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta do Azure Mapas no portal do Azure ou usa o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve country code from IP address

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
CountryRegion	O objeto que contém as informações de país/região.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IpAddressToLocationResult	Esse objeto é retornado de uma chamada bem-sucedida para o Endereço IP para a API de país/região
JsonFormat	Formato desejado da resposta. Há suporte apenas para o formato `json`.

CountryRegion

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

Nome	Tipo	Description
isoCode	string	O código de 2 caracteres do Endereço IP (ISO 3166-1) do país ou região. Observe que o endereço IP em intervalos reservados para fins especiais retornará Null para país/região.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IpAddressToLocationResult

Esse objeto é retornado de uma chamada bem-sucedida para o Endereço IP para a API de país/região

Nome	Tipo	Description
countryRegion	CountryRegion	O objeto que contém as informações de país/região.
ipAddress	string	O endereço IP da solicitação.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

Nome	Tipo	Description
json	string	O formato de intercâmbio de dados de notação de objeto JavaScript

Compartilhar via