Spatial - Post Closest Point

참조

서비스:: Maps

API 버전:: 2022-08-01

를 사용하여 기준점과 지정된 대상 지점 집합 간에 가장 가까운 지점을 가져옵니다.

Post Closest Point API는 기본 지점과 지정된 대상 지점 집합 간에 가장 가까운 지점을 반환하는 HTTP POST 요청입니다. 대상 지점 집합은 요청 후 본문의 사용자 데이터에 의해 제공됩니다. 사용자 데이터에는 Point geometry 컬렉션만 포함될 수 있습니다. 제공된 경우 MultiPoint 또는 기타 기하 도형은 무시됩니다. 알고리즘은 라우팅 또는 트래픽을 고려하지 않습니다. 허용되는 최대 포인트 수는 100,000입니다. 반환된 정보에는 가장 가까운 지점 위도, 경도 및 가장 가까운 지점으로부터의 거리(미터)가 포함됩니다.

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}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
format	path	True	JsonFormat	원하는 응답 형식입니다. `json` 형식만 지원됩니다.
geography	path	True	string	Azure Maps 계정의 위치입니다. 유효한 값은 당사(미국 동부, 미국 중서부, 미국 서부 2) 및 eu(북유럽, 서유럽)입니다. 이 매개 변수는 요청에 가 `udid` 제공된 경우에 필요합니다. 예를 들어 Azure Maps 계정이 미국 동부에 있는 경우 지리에 대한 요청만 수락됩니다.
api-version	query	True	string	Azure Maps API의 버전 번호.
lat	query	True	number	전달되는 위치의 위도입니다. 예: 48.36.
lon	query	True	number	전달되는 위치의 경도입니다. 예: -124.63.
numberOfClosestPoints	query		integer	응답에서 예상되는 가장 가까운 지점의 수입니다. 기본값: 1, 최소: 1 및 최대: 50

요청 헤더

Name	필수	형식	Description
x-ms-client-id		string	Microsoft Entra ID 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정에 대한 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps에서 Microsoft Entra ID 보안을 사용하려면 지침은 다음 문서를 참조하세요.

요청 본문

Name	필수	형식	Description
features	True	GeoJsonFeature[]	유효한 `GeoJSON Feature` 개체 목록을 포함합니다.
type	True	string: FeatureCollection	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

응답

Name	형식	Description
200 OK	ClosestPointResponse	정상
Other Status Codes	ErrorResponse	예기치 않은 오류가 발생했습니다.

보안

AADToken

다음은 Microsoft Entra OAuth 2.0 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 Azure Maps REST API에 대한 하나 이상의 권한으로 구성된 기본 제공 역할 또는 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하는 솔루션을 제공합니다.

참고

이 보안 정의를 사용하려면 헤더를 사용하여 애플리케이션이 x-ms-client-id 액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 지도 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 인스턴스와 관련이 있습니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면 에서 구성됩니다. * Azure Maps 웹 SDK 를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.

Microsoft ID 플랫폼에 대한 자세한 내용은 Microsoft ID 플랫폼 개요를 참조하세요.

형식: 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

Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스 를 만들 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있는 권한이 부여됩니다. 즉, 이러한 키는 현재 발급된 계정의 마스터 키로 처리될 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 이 키를 안전하게 저장할 수 있는 Azure Maps REST API의 서버-서버 액세스를 사용하는 것이 좋습니다.

형식: apiKey
In(다음 안에): header

SAS Token

Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스 의 SAS 나열 작업에서 생성된 공유 액세스 서명 토큰입니다.

이 토큰을 사용하면 모든 애플리케이션이 특정 토큰에 사용할 만료, 속도 및 지역에 대한 Azure 역할 기반 액세스 제어 및 세분화된 제어를 사용하여 액세스할 수 있는 권한이 부여됩니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 맵 계정 리소스 에서 허용되는 특정 원본 목록을 구성하는 것이 좋습니다.

형식: apiKey
In(다음 안에): header

예제

PostClosestPoint

Sample request

HTTP

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

Status code:: 200

{
  "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"
    }
  ]
}

정의

Name	Description
ClosestPoint	가장 가까운 점 결과 항목 개체
ClosestPointResponse	이 개체는 성공적인 공간 가장 가까운 지점 호출에서 반환됩니다.
ClosestPointSummary	가장 가까운 점 요약 개체
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
GeoJsonFeature	유효한 개체 형식입니다 `GeoJSON Feature` . 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonFeatureCollection	유효한 개체 형식입니다 `GeoJSON FeatureCollection` . 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonGeometry	유효한 `GeoJSON` geometry 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonGeometryCollection	유효한 개체 형식입니다 `GeoJSON GeometryCollection` . 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonLineString	유효한 `GeoJSON LineString` 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonMultiLineString	유효한 `GeoJSON MultiLineString` 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonMultiPoint	유효한 `GeoJSON MultiPoint` 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonMultiPolygon	유효한 개체 형식입니다 `GeoJSON MultiPolygon` . 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonPoint	유효한 `GeoJSON Point` 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.
GeoJsonPolygon	유효한 `GeoJSON Polygon` 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.
JsonFormat	원하는 응답 형식입니다. `json` 형식만 지원됩니다.
LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

ClosestPoint

가장 가까운 점 결과 항목 개체

Name	형식	Description
distanceInMeters	number	원본 지점에서 가장 가까운 지점까지의 거리(미터)
geometryId	string	고유 ID는 기하 도형을 식별합니다.
position	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

ClosestPointResponse

이 개체는 성공적인 공간 가장 가까운 지점 호출에서 반환됩니다.

Name	형식	Description
result	ClosestPoint[]	가장 가까운 점 결과 배열
summary	ClosestPointSummary	가장 가까운 점 요약 개체

ClosestPointSummary

가장 가까운 점 요약 개체

Name	형식	Description
information	string	처리 정보
sourcePoint	LatLongPairAbbreviated	짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.
udid	string	업로드된 콘텐츠에 대한 고유 데이터 ID(udid)

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

GeoJsonFeature

유효한 개체 형식입니다 GeoJSON Feature . 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
featureType	string	기능의 유형입니다. 값은 현재 기능이 속한 데이터 모델에 따라 달라집니다. 일부 데이터 모델에는 빈 값이 있을 수 있습니다.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	유효한 `GeoJSON` geometry 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 RFC 7946 을 참조하세요.
id	string	기능에 대한 식별자입니다.
type	string: Feature	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonFeatureCollection

유효한 개체 형식입니다 GeoJSON FeatureCollection . 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
features	GeoJsonFeature[]	유효한 `GeoJSON Feature` 개체 목록을 포함합니다.
type	string: FeatureCollection	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonGeometry

유효한 GeoJSON geometry 개체입니다. 이 형식은 Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon 및 GeometryCollection의 7가지 유효한 GeoJSON 기하 도형 형식 중 하나여야 합니다. 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
type	GeoJsonObjectType	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonGeometryCollection

유효한 개체 형식입니다 GeoJSON GeometryCollection . 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	유효한 `GeoJSON` 기하 도형 개체 목록을 포함합니다. GeoJSON의 좌표는 x, y 순서(경도, 위도)입니다.
type	string: GeometryCollection	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonLineString

유효한 GeoJSON LineString 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
coordinates	number[]	기하 도형의 `GeoJson LineString` 좌표입니다.
type	string: LineString	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonMultiLineString

유효한 GeoJSON MultiLineString 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
coordinates	number[]	기하 도형의 `GeoJson MultiLineString` 좌표입니다.
type	string: MultiLineString	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonMultiPoint

유효한 GeoJSON MultiPoint 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
coordinates	number[]	기하 도형의 `GeoJson MultiPoint` 좌표입니다.
type	string: MultiPoint	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonMultiPolygon

유효한 개체 형식입니다 GeoJSON MultiPolygon . 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
coordinates	number[]	유효한 `GeoJSON Polygon` 개체 목록을 포함합니다. GeoJSON의 좌표는 x, y 순서(경도, 위도)입니다.
type	string: MultiPolygon	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonPoint

유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
coordinates	number[]	`Position` 은 둘 이상의 요소가 있는 숫자 배열입니다. 처음 두 요소는 경도 및 위도이며 정확히 그 순서로 표시됩니다. 고도/상승 은 선택적 세 번째 요소입니다. 자세한 내용은 RFC 7946 을 참조하세요.
type	string: Point	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

GeoJsonPolygon

유효한 GeoJSON Polygon 기하 도형 형식입니다. 자세한 내용은 RFC 7946 을 참조하세요.

Name	형식	Description
coordinates	number[]	기하 도형 형식의 `GeoJson Polygon` 좌표입니다.
type	string: Polygon	`GeoJSON` 유형을 지정합니다. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature 및 FeatureCollection의 9가지 유효한 GeoJSON 개체 유형 중 하나여야 합니다.

JsonFormat

원하는 응답 형식입니다. json 형식만 지원됩니다.

Name	형식	Description
json	string	JavaScript 개체 표기법 데이터 교환 형식

LatLongPairAbbreviated

짧은 이름 '위도'& 'lon'을 사용하여 위도 및 경도로 표시되는 위치입니다.

Name	형식	Description
lat	number	위도 속성
lon	number	경도 속성

다음을 통해 공유