Geolocation - Get IP To Location
Use para obter o código ISO de país/região para um determinado endereço IP.
A Get IP To Location API é uma solicitação HTTP GET que retorna o código ISO de país/região para um determinado endereço IP. Os desenvolvedores podem usar essas informações para bloquear ou modificar o conteúdo com base na localização geográfica da qual o aplicativo é acessado.
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 |
Formato desejado da resposta. Há suporte apenas para |
|
|
api-version
|
query | True |
string |
Número de versão da API do Azure Mapas. |
|
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 |
Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
O pedido foi bem-sucedido. O recurso foi buscado e incluído no corpo da mensagem. |
|
| Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, 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 controlar o acesso em APIs e escopos específicos.
Anotações
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
O Authorization URL é específico para a instância de nuvem pública do Azure. 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 do 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ê Criar uma conta do Azure Mapas no portal do Azure ou usando 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 o aplicativos cliente confidenciais abordagem para acessar AS 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 LISTA 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 para expiração, taxa e região(s) 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 forma mais protegida do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Successfully retrieve country/region code from IP address
Solicitação de exemplo
GET https://atlas.microsoft.com/geolocation/ip/json?api-version=1.0&ip=2001:4898:80e8:b::189
Resposta de exemplo
{
"countryRegion": {
"isoCode": "US"
},
"ipAddress": "2001:4898:80e8:b::189"
}
Definições
| Nome | Description |
|---|---|
|
Country |
O objeto que contém as informações de país/região. |
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Ip |
Esse objeto é retornado de uma chamada bem-sucedida para o Endereço IP para a API de país/região |
|
Json |
Formato desejado da resposta. Há suporte apenas para |
CountryRegion
O objeto que contém as informações de país/região.
| Nome | Tipo | Description |
|---|---|---|
| isoCode |
string |
O código de país ou região de 2 caracteres do endereço IP (ISO 3166-1). Observe que os endereços IP em intervalos reservados para fins especiais retornarão 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 |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
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 |
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 json formato.
| Valor | Description |
|---|---|
| json |
o formato de intercâmbio de dados de notação de objeto JavaScript |