Geolocation - Get IP To Location

Odwołanie

Usługa:: Maps

Wersja interfejsu API:: 1.0

Użyj polecenia , aby uzyskać kod kraju ISO dla danego adresu IP

Interfejs Get IP To Location API jest żądaniem HTTP GET , które, biorąc pod uwagę adres IP, zwraca kod kraju ISO, z którego znajduje się ten adres IP. Deweloperzy mogą używać tych informacji do blokowania lub zmieniania określonej zawartości na podstawie lokalizacji geograficznych, z których aplikacja jest przeglądana.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.
api-version	query	True	string	Numer wersji interfejsu API usługi Azure Maps.
ip	query	True	string	Adres IP. Dozwolone są protokoły IPv4 i IPv6.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń microsoft Entra ID w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	IpAddressToLocationResult	OK
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu oparte na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id , aby wskazać, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu Sdk sieci Web usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Omówienie platformy tożsamości firmy Microsoft.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia konta usługi Azure Maps w witrynie Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsu API REST.

Przy użyciu tego klucza każda aplikacja może uzyskać dostęp do całego interfejsu API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu do interfejsów API REST usługi Azure Maps, aby można było bezpiecznie przechowywać klucz.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Typ: apiKey
W: header

Przykłady

Successfully retrieve country code from IP address

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
CountryRegion	Obiekt zawierający informacje o kraju/regionie.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IpAddressToLocationResult	Ten obiekt jest zwracany z pomyślnego wywołania adresu IP do interfejsu API kraju/regionu
JsonFormat	Żądany format odpowiedzi. Obsługiwany jest tylko `json` format.

CountryRegion

Obiekt zawierający informacje o kraju/regionie.

Nazwa	Typ	Opis
isoCode	string	Kod 2-znakowy adresu IP (ISO 3166-1) kraju lub regionu. Pamiętaj, że adres IP w zakresach zarezerwowanych dla specjalnego przeznaczenia zwróci wartość Null dla kraju/regionu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

IpAddressToLocationResult

Ten obiekt jest zwracany z pomyślnego wywołania adresu IP do interfejsu API kraju/regionu

Nazwa	Typ	Opis
countryRegion	CountryRegion	Obiekt zawierający informacje o kraju/regionie.
ipAddress	string	Adres IP żądania.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa	Typ	Opis
json	string	Format wymiany danych notacji obiektów JavaScript

Udostępnij za pośrednictwem