Spatial - Get Great Circle Distance
Use para determinar a distância mais curta entre dois pontos na superfície de uma esfera.
A Get Great Circle Distance
API é uma solicitação HTTP GET
que retorna o grande círculo ou a distância mais curta entre dois pontos na superfície de uma esfera, medida ao longo da superfície da esfera. Isso difere do cálculo de uma linha reta pelo interior da esfera. Esse método é útil para estimar distâncias de viagem para aviões calculando a distância mais curta entre os aeroportos.
GET https://{geography}.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query={query}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Formato desejado da resposta. Há suporte apenas para o formato |
|
geography
|
path | True |
string |
Local da conta do Azure Mapas. Os valores válidos são nós (Leste dos EUA, Centro-Oeste dos EUA, Oeste dos EUA 2) e UE (Norte da Europa, Europa Ocidental). Esse parâmetro é necessário quando um |
api-version
|
query | True |
string |
Número de versão da API de Mapas Azure. |
query
|
query | True |
string |
As Coordenadas pelas quais a distância é calculada, delimitadas por dois-pontos. Duas coordenadas são necessárias. A primeira é a coordenada do ponto de origem e a última é a coordenada do ponto de destino. Por exemplo, 47.622942,122.316456:57.673988,127.121513 |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Erro inesperado. |
Segurança
AADToken
Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do
x-ms-client-id
cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
O Authorization URL
é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID.
* O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada ao criar um recurso de Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como master chaves para a conta para a qual são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor de Azure Mapas APIs REST em que essa chave pode ser armazenada com segurança.
Type:
apiKey
In:
header
SAS Token
Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para a expiração, a taxa e as regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.
Type:
apiKey
In:
header
Exemplos
GetGreatCircleDistance
Sample Request
GET https://us.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query=47.622942,-122.316456:47.610378,-122.200676
Sample Response
{
"summary": {
"sourcePoint": {
"lat": 47.622942,
"lon": -122.316456
},
"targetPoint": {
"lat": 47.610378,
"lon": -122.200676
}
},
"result": {
"distanceInMeters": 8797.62
}
}
Definições
Nome | Description |
---|---|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
Os detalhes do erro. |
Error |
Resposta de erro |
Great |
Este objeto é retornado de uma chamada bem-sucedida de Great Circle Distance |
Great |
Objeto Summary |
Json |
Formato desejado da resposta. Há suporte apenas para o formato |
Lat |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
Result |
Ponto no objeto de resultado de polígono |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
Os detalhes do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
GreatCircleDistanceResult
Este objeto é retornado de uma chamada bem-sucedida de Great Circle Distance
Nome | Tipo | Description |
---|---|---|
result |
Objeto Result |
|
summary |
Objeto Summary |
GreatCircleDistanceSummary
Objeto Summary
Nome | Tipo | Description |
---|---|---|
sourcePoint |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
|
targetPoint |
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'. |
JsonFormat
Formato desejado da resposta. Há suporte apenas para o formato json
.
Nome | Tipo | Description |
---|---|---|
json |
string |
O formato de intercâmbio de dados de notação de objeto JavaScript |
LatLongPairAbbreviated
Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.
Nome | Tipo | Description |
---|---|---|
lat |
number |
Propriedade Latitude |
lon |
number |
Propriedade Longitude |
Result
Ponto no objeto de resultado de polígono
Nome | Tipo | Description |
---|---|---|
intersectingGeometries |
string[] |
Matriz de geometrias |
pointInPolygons |
boolean |
Propriedade Point In Polygons |