API —— Get Spatial Map list

This interface is used to paginate and retrieve the list information of all Spatial Maps under the current gallery.

1. Basic information

Endpoint: https://armap-api-<cn1,na1>.easyar.com/maps
HTTP Method: GET
Response Format: */* (Typically application/json)

2. Authentication

This interface supports the following two authentication modes:

Token-based Authentication:
- Header: Authorization: [token]
- Parameter: AppId must be included.
Signature-based Authentication:
- Uses APIKey, APISecret, AppId, and parameters to generate a signature for verification.
- For the detailed signature calculation algorithm, refer to API Key Signature Method.

3. Request parameters

3.1 Query parameters

Pagination parameters are optional. Default values will be used if not provided.

Parameter	Type	Required	Default	Description
pageNum	Integer	No	1	The target page number to request.
pageSize	Integer	No	10	The maximum number of maps per page.

4. Response data structure (ResponseResult)

When the request is successful (statusCode is 0), the result field will contain the map list and pagination metadata.

Field	Type	Description
statusCode	Integer	Status code. 0 indicates success.
msg	String	Status description message.
timestamp	DateTime	Server response timestamp.
result	Object	A Map object containing an array of map data and pagination statistics.

5. Status codes

HTTP Code	Meaning	Description
200	OK	Request succeeded.
401	Unauthorized	Authentication failed. Please check the Token or signature.
403	Forbidden	Access to the resource is forbidden.
404	Not Found	The requested resource was not found.

Status code error codes

Sparse spatial map APIs error code description

6. Example 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