Table of Contents

API —— Spatial Map 지도 목록 가져오기

이 인터페이스는 현재 갤러리 아래 모든 Spatial Map(공간 지도)의 목록 정보를 페이지별로 가져오는 데 사용됩니다.

1. 인터페이스 기본 정보

  • 인터페이스 주소: https://armap-api-<cn1,na1>.easyar.com/maps
  • 요청 방법: GET
  • 응답 형식: */* (일반적으로 application/json)

2. 인증 방식

이 인터페이스는 다음 두 가지 인증 모드를 지원합니다:

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

3. 요청 매개변수

3.1 쿼리 매개변수 (Query Parameters)

페이지 매개변수는 선택 사항이며, 입력하지 않으면 기본값이 사용됩니다.

매개변수 이름 유형 필수 여부 기본값 설명
pageNum Integer 아니오 1 요청할 대상 페이지 번호.
pageSize Integer 아니오 10 페이지당 표시할 최대 지도 수.

4. 응답 데이터 구조 (ResponseResult)

요청이 성공했을 때(statusCode가 0), 반환 결과 result는 지도 목록과 페이지네이션 메타데이터를 포함합니다.

필드 이름 유형 설명
statusCode Integer 상태 코드. 0은 성공을 의미합니다.
msg String 상태 설명 메시지.
timestamp DateTime 서버 응답 타임스탬프.
result Object 지도 데이터 배열 및 페이지네이션 통계 정보를 포함하는 Map 객체.

5. 상태 코드

Http Code 의미 설명
200 OK 요청 성공.
401 Unauthorized 인증 실패, Token 또는 서명을 확인하십시오.
403 Forbidden 해당 리소스에 대한 접근 권한이 없습니다.
404 Not Found 관련 리소스를 찾을 수 없습니다.

Status Code 오류 코드

6. 응답 예시 (JSON)

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