Table of Contents

Sparse Spatial Map 관리 APIs 소개

API 개요

REST API 프로토콜 및 인증 메커니즘

Spatial Map API 는 표준 HTTP REST 전송 사양을 따릅니다.

HTTP 헤더

    Authorization: <APIKey 에서 얻은 Token 을 입력>

HTTP 요청 매개변수는 두 가지 유형으로 나뉩니다:

  • 공용 매개변수(모두 포함되며, 인증 방식에 따라 다르게 사용됨):

    • appId
    • timestamp (Long 정수: 1970년 1월 1일 00:00:00 UTC 이후 경과한 밀리초)
    • apiKey
    • signature (요청 서명, token 인증 또는 signature 인증 중 하나 선택)

  • Spatial Map API 매개변수: API 고유의 매개변수

    API 문서에서는 인증에 사용되는 공용 매개변수를 더 이상 설명하지 않습니다

API Key 인증

인증 방식은 두 가지입니다.

토큰 기반 인증

HTTP 헤더 Authorization 에는 Token 이 포함되며, 공용 매개변수에는 다음이 포함됩니다:

  • appId

서명 인증

HTTP 헤더 Authorization 을 사용하지 않습니다.

요청 매개변수에는 서명 정보가 포함됩니다. 모든 매개변수가 서명 계산에 포함됩니다(이미지 제외).

  • appId
  • timestamp
  • apiKey
  • signature

서명 계산의 자세한 알고리즘은 API Key 서명 방법을 참고하세요.

사용 예제 및 속성 해석

API 사용 예제

다음 예제는 API 호출로 Spatial Map 데이터를 조회하여 개발자가 Spatial Map API 와 공간 맵 구조를 이해하도록 돕습니다.

요청 예제

  GET /maps HTTP/1.1
  Host:
  Date: Mon, 1 Jan 2018 00:00:00 GMT
  Content-Type: application/json
  {
      "timestamp": 1769406019000,
      "apiKey": "8b485c648c3056e79c2a85ee9b...",
      "appId": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9..",
      "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
  }

응답 예제

 {
  "result": {
    "armaps": [
      {
        "mapId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "gps": "[0.0, 0.0]",
        "name": "Map_2020-09-28_1302",
        "size": 124140,
        "status": "active",
        "auxiliaryId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "created": 1601245841687,
        "modified": 1601245841687,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "appKey": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9f.."
      },
      {
        "mapId": "5ccdf1fb-0cd3-4580-80aa-42bd2289...",
        "gps": "[0.0, 0.0]",
        "name": "test",
        "size": 2419184,
        "status": "active",
        "auxiliaryId": "5ccdf1fb-0cd3-4580-80aa-42bd22897b...",
        "floor": "1",
        "tag": "cat",
        "created": 1601244090670,
        "modified": 1601244090670,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley....",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...."
      }
    ],
    "page": {
      "total": 2,
      "pageNum": 1,
      "pageSize": 10,
      "pages": 1
    }
  },
  "statusCode": 0,
  "msg": "Success",
  "timestamp": 1769406021019
}

Sparse map 속성

위 예제에서 보듯이, 이것은 정상적으로 반환되는 Spatial Map 구조입니다

속성 설명
mapId 고유한 맵 ID
name 맵 이름
size 맵 파일 크기
meta 사용자 관련 데이터로, 파일, 텍스트 또는 url 이 될 수 있으며 base64 로 인코딩해야 합니다
status 비활성화 여부, 값은 [active inactive]
tag 쉽게 검색할 수 있는 사용자 정의 태그
floor 쉽게 검색할 수 있는 층
gps 공간의 지리적 위치, wgs84 좌표계 또는 자체 정의 좌표계
previewUrl 미리보기 이미지 다운로드

오류 코드

관련 주제