API —— Spatial Map 지도 검색
이 인터페이스는 Spatial Map(공간 지도) 검색에 사용됩니다. 모든 검색 매개변수는 선택 사항이며, 여러 필드로 검색할 경우 시스템은 "AND" 논리로 조건을 연결합니다.
1. 인터페이스 기본 정보
- 인터페이스 주소:
https://armap-api-<cn1,na1>.easyar.com/map - 요청 방법:
GET - 응답 형식:
*/*(일반적으로application/json)
2. 인증 방식
이 인터페이스는 다음 두 가지 인증 모드를 지원합니다:
- 토큰 기반 인증:
- 헤더:
Authorization: [token] - 매개변수:
AppId를 포함해야 합니다.
- 헤더:
- 서명(Signature) 기반 인증:
APIKey,APISecret,AppId및 매개변수를 사용하여 생성한 서명으로 검증합니다.- 서명 계산 상세 알고리즘은 API Key 서명 방법을 참조하세요.
3. 요청 매개변수
3.1 쿼리 매개변수 (Query Parameters)
모든 검색 매개변수는 선택 사항입니다.
| 매개변수 이름 | 유형 | 필수 여부 | 기본값 | 설명 |
|---|---|---|---|---|
| gps | String | 아니요 | - | 이 GPS 좌표 근처의 지도를 검색합니다. |
| range | Number | 아니요 | 1.0 | 검색 범위(단위: km). gps 매개변수와 함께 사용해야 합니다. |
| name | String | 아니요 | - | 지도 이름으로 검색합니다. |
| tag | String | 아니요 | - | 지도 태그로 검색합니다. |
4. 응답 데이터 구조 (ARMapDTO)
요청이 성공하면(statusCode가 0) result에 조건에 맞는 지도 객체 배열이 포함됩니다.
| 필드 이름 | 유형 | 설명 |
|---|---|---|
| statusCode | Integer | 상태 코드. 0은 성공을 의미합니다. |
| msg | String | 상태 설명 메시지. |
| timestamp | DateTime | 서버 응답 타임스탬프. |
| result | Array | ARMapDTO 객체 배열을 포함합니다. |
ARMapDTO 객체 구조
| 필드 이름 | 유형 | 설명 |
|---|---|---|
| mapId | String | 지도 고유 식별자. |
| name | String | 지도 이름. |
| status | String | 지도 현재 상태. |
| size | Integer (int64) | 지도 파일 크기. |
| gps | String | 지도와 연결된 GPS 좌표 정보. |
| tag | String | 지도 태그. |
| meta | String | 사용자 정의 메타데이터. |
| created | DateTime | 생성 시간. |
| modified | DateTime | 마지막 수정 시간. |
5. 상태 코드 (Status Codes)
| Http 코드 | 의미 | 설명 |
|---|---|---|
| 200 | OK | 요청 성공. |
| 401 | Unauthorized | 인증 실패, 토큰 또는 서명을 확인하세요. |
| 403 | Forbidden | 해당 리소스에 대한 접근 권한이 없습니다. |
Status Code 오류 코드
6. 응답 예시 (JSON)
{
"statusCode": 0,
"msg": "success",
"timestamp": "2026-01-30T10:00:00Z",
"result": [
{
"mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
"name": "office_scene",
"status": "active",
"gps": "121.4541,31.2221",
"tag": "indoor"
}
]
}