Table of Contents

API: Spatial Map 지도 정보 업데이트

이 API는 지정된 mapId를 통해 지도 정보를 업데이트합니다. HTTP PATCH와 유사한 업데이트 방식을 지원하며, request에 제공된 매개변수만 수정하고 제공되지 않은 매개변수는 그대로 유지합니다.

1. API 기본 정보

  • API 주소: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Request 메서드: PUT
  • Request 형식: multipart/form-data
  • Response 형식: */* (일반적으로 application/json)

2. 인증 방식

이 API는 다음 두 가지 인증 모드를 지원합니다.

  1. Token 기반 인증:
    • Header: Authorization: [token]
    • Parameter: AppId를 포함해야 합니다.
  2. Signature 기반 인증:
    • APIKey, APISecret, AppId 및 매개변수를 사용해 검증용 signature를 생성합니다.
    • signature 계산의 자세한 알고리즘은 API Key 서명 방법을 참조하십시오.

3. Request 매개변수

3.1 Path 매개변수 (Path Parameters)

매개변수 이름 유형 필수 설명
mapId String Spatial Map의 고유 식별자(MapId).

3.2 Form 매개변수 (Form Parameters)

multipart/form-data 형식을 사용하므로 다음 매개변수는 form field로 제출해야 합니다.

매개변수 이름 유형 필수 설명
file File 아니요 새 지도 데이터 파일.
name String 아니요 지도 표시 이름.
gps String 아니요 지도와 연결된 GPS 좌표. 예: "121.4541,31.2221".
tag String 아니요 지도 태그.
meta String 아니요 사용자 정의 메타데이터. 일반적으로 Base64로 인코딩된 문자열입니다.
clusterInfo String 아니요 cluster 관련 정보.
emeBlocklist String 아니요 EME blocklist 설정. 기본값은 "[]"입니다.

4. Response 데이터 구조 (ARMapDTO)

Request가 성공하면(statusCode가 0) 반환된 result에는 업데이트된 지도 객체의 세부 정보가 포함됩니다.

필드 이름 유형 설명
statusCode Integer 상태 코드. 0은 성공을 의미합니다.
msg String 상태 설명 정보.
timestamp DateTime 서버 response timestamp.
result Object 업데이트된 ARMapDTO 객체.

ARMapDTO 객체 구조

필드 이름 유형 설명
mapId String 지도 고유 식별자.
name String 지도 이름.
status String 지도의 현재 상태.
size Integer (int64) 지도 파일 크기(바이트).
gps String 지도와 연결된 GPS 좌표 정보.
tag String 지도 태그.
meta String 사용자 정의 메타데이터.
md5 String 업데이트된 지도 파일의 MD5 checksum.
modified DateTime 마지막 수정 시간.

5. 상태 코드

Http Code 의미 설명
200 OK Request 성공.
201 Created 업데이트 성공 및 관련 레코드 생성 완료.
401 Unauthorized 인증 실패. Token 또는 signature를 확인하십시오.
403 Forbidden 이 리소스에 접근할 권한이 없습니다.
404 Not Found 지정된 mapId를 찾을 수 없습니다.

Status Code 오류 코드

6. Response 예 (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
    "name": "updated_office_scene",
    "status": "active",
    "gps": "121.4541,31.2221",
    "modified": "2026-01-30T10:00:00Z"
  }
}