Spatial - Get Closest Point

Başvuru

Service:: Maps

API Version:: 2022-08-01

Temel nokta ile belirli bir hedef nokta kümesi arasındaki en yakın noktayı almak için kullanın.

Get Closest Point API, tarafından tanımlanan udidkullanıcı tarafından karşıya yüklenen veri kümesindeki temel nokta ile belirli bir nokta kümesi arasındaki en yakın nokta olan bir HTTP GET isteğidir. Hedef nokta kümesi, Veri kayıt defteri hizmeti kullanılarak karşıya yüklenen ve benzersiz bir udid tarafından başvurulan bir GeoJSON dosyası tarafından sağlanır. GeoJSON dosyası yalnızca Nokta geometrisi koleksiyonunu içerebilir. MultiPoint veya diğer geometriler sağlanırsa yoksayılır. Kabul edilen maksimum puan sayısı 100.000'dir. Algoritma yönlendirmeyi veya trafiği dikkate almaz. Döndürülen bilgiler en yakın nokta enlemini, boylamını ve en yakın noktadan metre olarak uzaklığı içerir.

Bu API'yi test etmek için Veri kayıt defteri hizmetini kullanarak Post Closest Point API örneklerinden (İstek Gövdesi) örnek verileri karşıya yükleyebilir ve aşağıdaki örnek istekten değerini veri kayıt defteri oluşturulurken kullanılanla udid değiştirebilirsiniz{udid}. Daha fazla bilgi için bkz. Veri kayıt defteri oluşturma.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
format	path	True	JsonFormat	Yanıtın istenen biçimi. Yalnızca `json` biçim desteklenir.
geography	path	True	string	Azure Haritalar Hesabının konumu. Geçerli değerler: ABD (Doğu ABD, Orta Batı ABD, Batı ABD 2) ve AB (Kuzey Avrupa, Batı Avrupa). İstekte bir `udid` sağlandığında bu parametre gereklidir. Örneğin, Azure Haritalar Hesabı Doğu ABD'de bulunuyorsa, yalnızca bize yapılan coğrafya istekleri kabul edilir.
api-version	query	True	string	Azure Haritalar API'sinin sürüm numarası.
lat	query	True	number	Geçirilen konumun enlemi. Örnek: 48.36.
lon	query	True	number	Geçirilen konumun boylamı. Örnek: -124.63.
udid	query	True	string	Geçerli bir GeoJSON FeatureCollection nesnesini karşıya yüklemek için Veri kayıt defteri oluştururken kullanılan benzersiz kimlik. Ayrıntılar için lütfen RFC 7946'ya bakın. Özelliğin tüm özellikleri, geometriyi tanımlamak için kullanılan ve büyük/küçük harfe duyarlı olan özelliklerini içermelidir `geometryId`. Veri kayıt defteri hizmeti hakkında daha fazla bilgi için bkz. Veri kayıt defteri oluşturma.
numberOfClosestPoints	query		integer	Yanıttan beklenen en yakın nokta sayısı. Varsayılan: 1, en az: 1 ve maksimum: 50

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-id		string	Hangi hesabın Microsoft Entra ID güvenlik modeliyle birlikte kullanıma yönelik olduğunu belirtir. Azure Haritalar hesabı için benzersiz bir kimliği temsil eder ve Azure Haritalar yönetim düzlemi Hesap API'sinden alınabilir. Azure Haritalar Microsoft Entra ID güvenliğini kullanmak için kılavuz için aşağıdaki makalelere bakın.

Yanıtlar

Name	Tür	Description
200 OK	ClosestPointResponse	Tamam
Other Status Codes	ErrorResponse	Beklenmeyen bir hata oluştu.

Güvenlik

AADToken

Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimiyle eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağına erişimi tanımlamak için kullanılır. Herhangi bir kullanıcı, grup veya hizmet sorumlusuna yerleşik bir rol veya REST API'lerini Azure Haritalar için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.

Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemeye yönelik bir çözüm sağlar.

Notlar

Bu güvenlik tanımı, uygulamanın erişim isteğinde x-ms-client-id bulunduğu Azure Haritalar kaynağı belirtmek için üst bilginin kullanılmasını gerektirir. Bu, Haritalar yönetim API'sinden edinilebilir.

Authorization URL, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Microsoft Entra ID yapılandırmaları vardır. * Azure rol tabanlı erişim denetimi Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzleminden yapılandırılır. * Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.

Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformu genel bakış.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Bu, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağı oluştururken sağlanan paylaşılan bir anahtardır.

Bu anahtarla, tüm uygulamalar tüm REST API'lerine erişim yetkisine sahip olur. Başka bir deyişle, bunlar şu anda verildikleri hesabın ana anahtarları olarak kabul edilebilir.

Genel kullanıma sunulan uygulamalar için önerimiz, bu anahtarın güvenli bir şekilde depolanabildiği Azure Haritalar REST API'lerinin sunucudan sunucuya erişiminin kullanılmasıdır.

Type: apiKey
In: header

SAS Token

Bu paylaşılan erişim imzası belirteci, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzlemi aracılığıyla Azure Haritalar kaynağındaki Sas Listeleme işleminden oluşturulur.

Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirtecin kullanım süresi, oranı ve bölgelerine yönelik ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların erişimi paylaşılan anahtardan daha güvenli bir şekilde denetlemesine izin vermek için kullanılabilir.

Herkese açık uygulamalar için önerimiz, uygunsuz işlemeyi sınırlamak ve SAS Belirtecini düzenli olarak yenilemek için Harita hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmanızdır.

Type: apiKey
In: header

Örnekler

GetClosestPoint

Sample Request

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

Sample Response

Status code:: 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"
    }
  ]
}

Tanımlar

Name	Description
ClosestPoint	En Yakın Nokta Sonuç Giriş Nesnesi
ClosestPointResponse	Bu nesne başarılı bir Uzamsal En Yakın Nokta çağrısından döndürülür
ClosestPointSummary	En Yakın Nokta Özeti nesnesi
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
JsonFormat	Yanıtın istenen biçimi. Yalnızca `json` biçim desteklenir.
LatLongPairAbbreviated	'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

ClosestPoint

En Yakın Nokta Sonuç Giriş Nesnesi

Name	Tür	Description
distanceInMeters	number	Metrelerdeki kaynak noktadan en yakın noktaya olan uzaklık
geometryId	string	Benzersiz kimlik bir geometriyi tanımlar
position	LatLongPairAbbreviated	'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

ClosestPointResponse

Bu nesne başarılı bir Uzamsal En Yakın Nokta çağrısından döndürülür

Name	Tür	Description
result	ClosestPoint[]	En Yakın Nokta Sonuç Dizisi
summary	ClosestPointSummary	En Yakın Nokta Özeti nesnesi

ClosestPointSummary

En Yakın Nokta Özeti nesnesi

Name	Tür	Description
information	string	Bilgiler işleniyor
sourcePoint	LatLongPairAbbreviated	'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.
udid	string	Karşıya yüklenen içerik için benzersiz bir veri kimliği (udid)

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

JsonFormat

Yanıtın istenen biçimi. Yalnızca json biçim desteklenir.

Name	Tür	Description
json	string	JavaScript Nesne Gösterimi Veri Değişim Biçimi

LatLongPairAbbreviated

'lon' & 'lat' kısa adları kullanılarak enlem ve boylam olarak temsil edilen konum.

Name	Tür	Description
lat	number	Latitude özelliği
lon	number	Longitude özelliği