Spatial - Post Closest Point
Usare per ottenere il punto più vicino tra un punto di base e un determinato set di punti di destinazione.
L'API Post Closest Point
è una richiesta HTTP POST
che restituisce il punto più vicino tra un punto di base e un determinato set di punti di destinazione. Il set di punti di destinazione viene fornito dai dati utente nel corpo della richiesta. I dati utente possono contenere solo una raccolta di geometria point. Se specificato, multiPoint o altre geometrie verrà ignorato. L'algoritmo non tiene conto del routing o del traffico. Il numero massimo di punti accettati è 100.000. Le informazioni restituite includono latitudine, longitudine e distanza più vicina dal punto più vicino.
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}
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
format
|
path | True |
Formato desiderato della risposta. È supportato solo il formato |
|
geography
|
path | True |
string |
Posizione dell'account Mappe di Azure. I valori validi sono stati (Stati Uniti orientali, Stati Uniti centro-occidentali, Stati Uniti occidentali 2) ed eu (Europa settentrionale, Europa occidentale). Questo parametro è necessario quando viene fornito un |
api-version
|
query | True |
string |
Numero di versione dell'API Mappe di Azure. |
lat
|
query | True |
number |
Latitudine della posizione passata. Esempio: 48.36. |
lon
|
query | True |
number |
Longitudine della posizione passata. Esempio: -124.63. |
number
|
query |
integer |
Numero di punti più vicini previsti dalla risposta. Impostazione predefinita: 1, minimo: 1 e massimo: 50 |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
x-ms-client-id |
string |
Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
features | True |
Contiene un elenco di oggetti validi |
|
type | True |
string:
Feature |
Specifica il tipo di oggetto |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Si è verificato un errore imprevisto. |
Sicurezza
AADToken
Si tratta dei flussi Microsoft Entra OAuth 2.0 . Quando è associato al controllo degli accessi in base al ruolo di Azure , può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più account delle risorse delle risorse di Mappe di Azure o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.
Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-id
per indicare la risorsa mappe di Azure a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.
L'oggetto Authorization URL
è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di URL di autorizzazione univoci e configurazioni di Microsoft Entra ID.
* Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
* L'utilizzo di Azure Maps Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
- Per altre informazioni su Microsoft Identity Platform, vedere Panoramica di Microsoft Identity Platform.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Si tratta di una chiave condivisa di cui viene eseguito il provisioning durante la creazione di una risorsa mappe di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati come chiavi master per l'account per cui vengono rilasciati.
Per le applicazioni esposte pubblicamente, è consigliabile usare l'accesso da server a server delle API REST di Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.
Tipo:
apiKey
In:
header
SAS Token
Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nella risorsa mappe di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso basati sul ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.
Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.
Tipo:
apiKey
In:
header
Esempio
PostClosestPoint
Esempio di richiesta
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
]
}
}
]
}
Risposta di esempio
{
"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"
}
]
}
Definizioni
Nome | Descrizione |
---|---|
Closest |
Oggetto Entry Risultato punto più vicino |
Closest |
Questo oggetto viene restituito da una chiamata al punto spaziale più vicino riuscita |
Closest |
Oggetto Summary punto più vicino |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Geo |
Tipo di oggetto valido |
Geo |
Tipo di oggetto valido |
Geo |
Oggetto geometry valido |
Geo |
Tipo di oggetto valido |
Geo |
Tipo di geometria valido |
Geo |
Tipo di geometria valido |
Geo |
Tipo di geometria valido |
Geo |
Tipo di oggetto valido |
Geo |
Tipo di geometria valido |
Geo |
Tipo di geometria valido |
Json |
Formato desiderato della risposta. È supportato solo il formato |
Lat |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
ClosestPoint
Oggetto Entry Risultato punto più vicino
Nome | Tipo | Descrizione |
---|---|---|
distanceInMeters |
number |
Distanza in metri dal punto di origine al punto più vicino |
geometryId |
string |
L'ID univoco identifica una geometria |
position |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
ClosestPointResponse
Questo oggetto viene restituito da una chiamata al punto spaziale più vicino riuscita
Nome | Tipo | Descrizione |
---|---|---|
result |
Matrice dei risultati del punto più vicino |
|
summary |
Oggetto Summary punto più vicino |
ClosestPointSummary
Oggetto Summary punto più vicino
Nome | Tipo | Descrizione |
---|---|---|
information |
string |
Elaborazione delle informazioni |
sourcePoint |
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'. |
|
udid |
string |
ID dati univoco (udid) per il contenuto caricato |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
GeoJsonFeature
Tipo di oggetto valido GeoJSON Feature
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
featureType |
string |
Tipo di funzionalità. Il valore dipende dal modello di dati di cui fa parte la funzionalità corrente. Alcuni modelli di dati possono avere un valore vuoto. |
geometry | GeoJsonGeometry: |
Oggetto geometry valido |
id |
string |
Identificatore della funzionalità. |
type |
string:
Feature |
Specifica il tipo di oggetto |
GeoJsonFeatureCollection
Tipo di oggetto valido GeoJSON FeatureCollection
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
features |
Contiene un elenco di oggetti validi |
|
type |
string:
Feature |
Specifica il tipo di oggetto |
GeoJsonGeometry
Oggetto geometry valido GeoJSON
. Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
type |
Geo |
Specifica il tipo di oggetto |
GeoJsonGeometryCollection
Tipo di oggetto valido GeoJSON GeometryCollection
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
geometries | GeoJsonGeometry[]: |
Contiene un elenco di oggetti geometry validi |
type |
string:
Geometry |
Specifica il tipo di oggetto |
GeoJsonLineString
Tipo di geometria valido GeoJSON LineString
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
coordinates |
number[] |
Coordinate per la |
type |
string:
Line |
Specifica il tipo di oggetto |
GeoJsonMultiLineString
Tipo di geometria valido GeoJSON MultiLineString
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
coordinates |
number[] |
Coordinate per la |
type |
string:
Multi |
Specifica il tipo di oggetto |
GeoJsonMultiPoint
Tipo di geometria valido GeoJSON MultiPoint
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
coordinates |
number[] |
Coordinate per la |
type |
string:
Multi |
Specifica il tipo di oggetto |
GeoJsonMultiPolygon
Tipo di oggetto valido GeoJSON MultiPolygon
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
coordinates |
number[] |
Contiene un elenco di oggetti validi |
type |
string:
Multi |
Specifica il tipo di oggetto |
GeoJsonPoint
Tipo di geometria valido GeoJSON Point
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
coordinates |
number[] |
Un |
type |
string:
Point |
Specifica il tipo di oggetto |
GeoJsonPolygon
Tipo di geometria valido GeoJSON Polygon
. Per informazioni dettagliate, vedere RFC 7946 .
Nome | Tipo | Descrizione |
---|---|---|
coordinates |
number[] |
Coordinate per il |
type |
string:
Polygon |
Specifica il tipo di oggetto |
JsonFormat
Formato desiderato della risposta. È supportato solo il formato json
.
Nome | Tipo | Descrizione |
---|---|---|
json |
string |
LatLongPairAbbreviated
Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
Nome | Tipo | Descrizione |
---|---|---|
lat |
number |
Proprietà Latitude |
lon |
number |
Longitudine - proprietà |