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

이 API는 현재 이미지 라이브러리 아래의 모든 Spatial Map 목록 정보를 페이지 단위로 가져오는 데 사용됩니다.

1. API 기본 정보

API 주소: https://armap-api-<cn1,na1>.easyar.com/maps
Request 메서드: GET
Response 형식: */* (일반적으로 application/json)

2. 인증 방식

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

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

3. Request 매개변수

3.1 Query 매개변수 (Query Parameters)

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

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

4. Response 데이터 구조 (ResponseResult)

Request가 성공하면(statusCode가 0) 반환된 result에는 지도 목록과 페이지 메타데이터가 포함됩니다.

필드 이름	유형	설명
statusCode	Integer	상태 코드. 0은 성공을 의미합니다.
msg	String	상태 설명 정보.
timestamp	DateTime	서버 response timestamp.
result	Object	지도 데이터 배열과 페이지 통계 정보를 포함하는 Map 객체.

5. 상태 코드

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

Status Code 오류 코드

Sparse Spatial Map APIs 상태 코드 설명

6. Response 예 (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
}

Table of Contents