Spatial - Post Closest Point
Użyj polecenia , aby uzyskać najbliższy punkt między punktem bazowym a danym zestawem punktów docelowych.
Interfejs Post Closest Point
API to żądanie HTTP POST
zwracające najbliższy punkt między punktem bazowym a danym zestawem punktów docelowych. Zestaw punktów docelowych jest dostarczany przez dane użytkownika w treści żądania. Dane użytkownika mogą zawierać tylko kolekcję geometrii punktu. MultiPoint lub inne geometrie zostaną zignorowane, jeśli zostanie podana. Algorytm nie uwzględnia routingu ani ruchu. Maksymalna liczba akceptowanych punktów wynosi 100 000. Zwrócone informacje obejmują najbliższą szerokość geograficzną, długość geograficzną i odległość w metrach od najbliższego punktu.
POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}
POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}&numberOfClosestPoints={numberOfClosestPoints}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
format
|
path | True |
Json |
Żądany format odpowiedzi. Obsługiwany jest tylko |
geography
|
path | True |
string |
Lokalizacja konta Azure Maps. Prawidłowe wartości to nas (Wschodnie stany USA, Zachodnie stany USA, Zachodnie stany USA 2) i eu (Europa Północna, Europa Zachodnia). Ten parametr jest wymagany, gdy |
api-version
|
query | True |
string |
Numer wersji interfejsu API Azure Maps. |
lat
|
query | True |
number |
Szerokość geograficzna przekazywanej lokalizacji. Przykład: 48.36. |
lon
|
query | True |
number |
Długość geograficzna przekazywanej lokalizacji. Przykład: -124.63. |
number
|
query |
integer |
Liczba najbliższych punktów oczekiwana od odpowiedzi. Wartość domyślna: 1, minimalna: 1 i maksymalna: 50 |
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ń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
features | True |
Geo |
Zawiera listę prawidłowych |
type | True |
string:
Feature |
Określa |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Closest |
OK |
Other Status Codes |
Error |
Wystąpił nieoczekiwany błąd. |
Zabezpieczenia
AADToken
Są to przepływy 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 Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów 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 Azure Maps interfejsów API REST.
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 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 Tożsamość Microsoft Entra.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
* Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenia zasobu Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Przy użyciu tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.
W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu do serwera Azure Maps interfejsów API REST, w których ten klucz może być bezpiecznie przechowywany.
Type:
apiKey
In:
header
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem 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.
Type:
apiKey
In:
header
Przykłady
PostClosestPoint
Sample Request
POST https://us.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat=47.622942&lon=-122.316456
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": 1001
},
"geometry": {
"type": "Point",
"coordinates": [
-105.02860293715861,
40.51615340677395
]
}
},
{
"type": "Feature",
"properties": {
"geometryId": 1002
},
"geometry": {
"type": "Point",
"coordinates": [
-105.02860381672178,
40.51599099003731
]
}
},
{
"type": "Feature",
"properties": {
"geometryId": 1003
},
"geometry": {
"type": "Point",
"coordinates": [
-105.02812292879467,
40.51605867808856
]
}
}
]
}
Sample Response
{
"summary": {
"sourcePoint": {
"lat": 47.622942,
"lon": -122.316456
},
"udid": null,
"information": "3 points processed in user data"
},
"result": [
{
"distanceInMeters": 1587492.66,
"position": {
"lat": 40.51615340677395,
"lon": -105.02860293715861
},
"geometryId": "1001"
}
]
}
Definicje
Nazwa | Opis |
---|---|
Closest |
Obiekt wprowadzania wyników najbliższego punktu |
Closest |
Ten obiekt jest zwracany z pomyślnego wywołania najbliższego punktu przestrzennego |
Closest |
Obiekt podsumowania najbliższego punktu |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Geo |
Prawidłowy |
Json |
Żądany format odpowiedzi. Obsługiwany jest tylko |
Lat |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
ClosestPoint
Obiekt wprowadzania wyników najbliższego punktu
Nazwa | Typ | Opis |
---|---|---|
distanceInMeters |
number |
Odległość w metrach od punktu źródłowego do najbliższego punktu |
geometryId |
string |
Unikatowy identyfikator identyfikuje geometrię |
position |
Lat |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
ClosestPointResponse
Ten obiekt jest zwracany z pomyślnego wywołania najbliższego punktu przestrzennego
Nazwa | Typ | Opis |
---|---|---|
result |
Closest |
Tablica wyników najbliższego punktu |
summary |
Closest |
Obiekt podsumowania najbliższego punktu |
ClosestPointSummary
Obiekt podsumowania najbliższego punktu
Nazwa | Typ | Opis |
---|---|---|
information |
string |
Przetwarzanie informacji |
sourcePoint |
Lat |
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon". |
udid |
string |
Unikatowy identyfikator danych (udid) dla przekazanej zawartości |
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 |
Error |
Dodatkowe informacje o błędzie. |
code |
string |
Kod błędu. |
details |
Error |
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 |
Error |
Obiekt error. |
GeoJsonFeature
Prawidłowy GeoJSON Feature
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
featureType |
string |
Typ funkcji. Wartość zależy od modelu danych, do której należy bieżąca funkcja. Niektóre modele danych mogą mieć pustą wartość. |
geometry |
GeoJsonGeometry:
|
Prawidłowy |
id |
string |
Identyfikator funkcji. |
type |
string:
Feature |
Określa |
GeoJsonFeatureCollection
Prawidłowy GeoJSON FeatureCollection
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
features |
Geo |
Zawiera listę prawidłowych |
type |
string:
Feature |
Określa |
GeoJsonGeometry
Prawidłowy GeoJSON
obiekt geometryczny. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
type |
Geo |
Określa |
GeoJsonGeometryCollection
Prawidłowy GeoJSON GeometryCollection
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
geometries |
GeoJsonGeometry[]:
|
Zawiera listę prawidłowych |
type |
string:
Geometry |
Określa |
GeoJsonLineString
Prawidłowy GeoJSON LineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Line |
Określa |
GeoJsonMultiLineString
Prawidłowy GeoJSON MultiLineString
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPoint
Prawidłowy GeoJSON MultiPoint
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne geometrii |
type |
string:
Multi |
Określa |
GeoJsonMultiPolygon
Prawidłowy GeoJSON MultiPolygon
typ obiektu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Zawiera listę prawidłowych |
type |
string:
Multi |
Określa |
GeoJsonPoint
Prawidłowy GeoJSON Point
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Określa |
GeoJsonPolygon
Prawidłowy GeoJSON Polygon
typ geometrii. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 .
Nazwa | Typ | Opis |
---|---|---|
coordinates |
number[] |
Współrzędne dla |
type |
string:
Polygon |
Określa |
JsonFormat
Żądany format odpowiedzi. Obsługiwany jest tylko json
format.
Nazwa | Typ | Opis |
---|---|---|
json |
string |
LatLongPairAbbreviated
Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".
Nazwa | Typ | Opis |
---|---|---|
lat |
number |
Właściwość Szerokość geograficzna |
lon |
number |
Właściwość Długość geograficzna |