Spatial - Get Closest Point

Referencia

Szolgáltatás:: Maps

API-verzió:: 2022-08-01

Az alappont és egy adott célpontcsoport közötti legközelebbi pont lekéréséhez használható.

Az Get Closest Point API egy HTTP-kérés GET , amely a legközelebbi pont az alappont és a felhasználó által udidfeltöltött adatkészlet adott pontkészlete között. A célpontok készletét egy GeoJSON-fájl biztosítja, amelyet az Adatregisztrációs adatbázis szolgáltatással tölt fel, és egy egyedi udid hivatkozik rá. A GeoJSON-fájl csak pontgeometriai gyűjteményt tartalmazhat. A multiPoint vagy más geometriák figyelmen kívül lesznek hagyva, ha meg vannak adva. Az elfogadott pontok maximális száma 100 000. Az algoritmus nem veszi figyelembe az útválasztást vagy a forgalmat. A visszaadott információk közé tartozik a legközelebbi pont szélessége, hosszúsága és távolsága a legközelebbi ponttól mért méterben.

Az API teszteléséhez feltöltheti a mintaadatokat a Post Closest Point API-példákból (Kérelemtörzs) az Adatregisztrációs adatbázis szolgáltatással, és lecserélheti az {udid}alábbi mintakérelmet az udid adatregisztrációs adatbázis létrehozásakor használtra. További információ: Adatregisztrációs adatbázis létrehozása.

GET https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}

Opcionális paraméterekkel:

GET https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}&numberOfClosestPoints={numberOfClosestPoints}

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
geography	path	True	string	Az Azure Maps-fiók helye. Érvényes értékek: mi (USA keleti régiója, USA nyugati középső régiója, USA 2. nyugati régiója) és az EU (Észak-Európa, Nyugat-Európa). Erre a paraméterre akkor van szükség, ha a `udid` kérelemben egy meg van adva. Ha például az Azure Maps-fiók az USA keleti régiójában található, a rendszer csak a földrajzra vonatkozó kéréseket fogadja el.
api-version	query	True	string	Az Azure Maps API verziószáma.
lat	query	True	number	Az átadott hely szélessége. Példa: 48.36.
lon	query	True	number	Az átadott hely hosszúsága. Példa: -124.63.
udid	query	True	string	Az adatregisztrációs adatbázis létrehozásakor használt egyedi azonosító egy érvényes GeoJSON FeatureCollection-objektum feltöltéséhez. A részletekért tekintse meg az RFC 7946-ot . A funkció minden tulajdonságának tartalmaznia kell , `geometryId`amely a geometria azonosítására szolgál, és megkülönbözteti a kis- és nagybetűk megkülönböztetését. További információ az adatregisztrációs adatbázis szolgáltatásról: Adatregisztrációs adatbázis létrehozása.
numberOfClosestPoints	query		integer	A választól várt legközelebbi pontok száma. Alapértelmezett: 1, minimum: 1 és maximum: 50

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. Az Azure Maps-fiók egyedi azonosítóját jelöli, és lekérhető az Azure Maps felügyeleti síkjának Fiók API-jából. A Microsoft Entra ID-biztonság Azure Mapsben való használatához tekintse meg az alábbi cikkeket .

Válaszok

Name	Típus	Description
200 OK	ClosestPointResponse	OK
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0 folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel, vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát x-ms-client-id annak jelzéséhez, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

A Microsoft identitásplatformról további információt a Microsoft identitásplatform áttekintése című témakörben talál.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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

subscription-key

Ez egy megosztott kulcs, amely akkor van kiépítve, amikor Azure Maps-erőforrást hoz létre az Azure Felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyhez ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy az Azure Maps REST API-k kiszolgálóról kiszolgálóra történő hozzáférését használja, ahol ez a kulcs biztonságosan tárolható.

Típus: apiKey
In: header

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat az Azure Maps-erőforrás Sas listázási műveletéből jön létre az Azure Felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

GetClosestPoint

Mintakérelem

HTTP

GET https://us.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&lat=47.622942&lon=-122.316456

Mintaválasz

Állapotkód:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 47.622942,
      "lon": -122.316456
    },
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "information": "10 points processed in user data"
  },
  "result": [
    {
      "distanceInMeters": 1587492.66,
      "position": {
        "lat": 40.51615340677395,
        "lon": -105.02860293715861
      },
      "geometryId": "1001"
    }
  ]
}

Definíciók

Name	Description
ClosestPoint	Legközelebbi pont eredménybeviteli objektuma
ClosestPointResponse	Ezt az objektumot egy sikeres Térbeli legközelebbi pont hívása adja vissza
ClosestPointSummary	Legközelebbi pont összegzési objektuma
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".

ClosestPoint

Legközelebbi pont eredménybeviteli objektuma

Name	Típus	Description
distanceInMeters	number	A mérők távolsága a forrásponttól a legközelebbi pontig
geometryId	string	Az egyedi azonosító egy geometriát azonosít
position	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".

ClosestPointResponse

Ezt az objektumot egy sikeres Térbeli legközelebbi pont hívása adja vissza

Name	Típus	Description
result	ClosestPoint[]	Legközelebbi pont eredménytömbje
summary	ClosestPointSummary	Legközelebbi pont összegzési objektuma

ClosestPointSummary

Legközelebbi pont összegzési objektuma

Name	Típus	Description
information	string	Adatok feldolgozása
sourcePoint	LatLongPairAbbreviated	Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".
udid	string	A feltöltött tartalom egyedi adatazonosítója (udid)

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript-objektum jelölési adatcseréjének formátuma

LatLongPairAbbreviated

Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".

Name	Típus	Description
lat	number	Latitude tulajdonság
lon	number	Hosszúság tulajdonság

Megosztás a következőn keresztül: