Classic/VPC 환경에서 이용 가능합니다.
e-map 또는 로봇맵 변환 결과가 존재하는 로케이션 목록을 조회합니다. 응답 결과는 Task 종류에 따라 달라집니다. emapper의 경우 변환 결과가 있는 최상위 로케이션 1건이 반환되며, robot-map의 경우 로봇맵 결과가 존재하는 층(floor) 단위 로케이션 목록이 반환됩니다.
사전 단계
Map Data - 로케이션 조회 API를 사용하기 위한 사전 단계는 다음과 같습니다.
1. e-map 생성 또는 로봇맵 생성
콘솔에서 대상 최상위 로케이션에 대해 e-map 생성 또는 로봇맵 생성 작업을 수행하고 성공 상태까지 완료해 주십시오. 자세한 진행 방법은 ARC eye 사용 가이드를 참조해 주십시오.
2. Secret Key 발급
네이버 클라우드 플랫폼 콘솔의 Menu > Services > Digital Twin > ARC eye > Visual Localization > Data Management 메뉴에서 대상 Emapper 또는 RobotMap 작업 상세의 Secret Key의 [생성] 버튼을 클릭하여 Map Data 전용 Secret Key를 발급받아 주십시오. 자세한 방법은 ARC eye 사용 가이드를 참조해 주십시오.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /map-data/v1/{projectId}/{signature}/{task}/locations |
ARC eye 공통 설정 > API URL의 다운로드 URL 조회 API URL의 마지막 경로 /download-urls를 /locations로 치환하여 호출합니다.
요청 헤더
ARC eye API에서 공통으로 사용하는 헤더에 대한 정보는 ARC eye 요청 헤더를 참조해 주십시오.
요청 경로 변수
요청 경로 변수에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
projectId |
Number | Required | 프로젝트 ID
|
signature |
String | Required | 프로젝트 서명 값
|
task |
String | Required | 조회 대상 Task 종류
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET '{InvokeURL}' \
--header 'X-ARCEYE-SECRET: {SecretKey}'
응답
응답 형식을 설명합니다.
응답 바디(성공)
조회가 성공한 경우의 응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
locations |
Array | - | 결과가 존재하는 로케이션 목록: locations |
locations
locations에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
locationId |
Number | - | 로케이션 ID |
locationName |
String | - | 로케이션 이름 |
locationNamePath |
String | - | 최상위 로케이션부터 해당 로케이션까지의 이름을 _로 연결한 값
|
응답 예시
응답 예시는 다음과 같습니다.
성공(emapper)
emapper 호출이 성공한 경우의 응답 예시는 다음과 같습니다.
{
"locations": [
{
"locationId": 1001,
"locationName": "Office",
"locationNamePath": "Office"
}
]
}
성공(robot-map)
robot-map 호출이 성공한 경우의 응답 예시는 다음과 같습니다.
{
"locations": [
{
"locationId": 2001,
"locationName": "1F",
"locationNamePath": "Office_1F"
},
{
"locationId": 2002,
"locationName": "B1F",
"locationNamePath": "Office_B1F"
}
]
}
API 호출이 실패한 경우의 응답 바디와 응답 예시는 ARC eye 개요를 참조해 주십시오.