Sparse spatial map data management
This chapter explains how to manage Sparse Spatial Map data.
Data
The management process of map data is as follows:
- Generation and upload: Maps are automatically generated by EasyAR Sense on the device side and uploaded to the cloud in a proprietary format.
- Cloud management: Through management APIs, developers can integrate features such as adding, deleting, modifying, and querying maps.
- Sharing and distribution: Supports map sharing, allowing maps uploaded by any device to be used by other devices for localization, enabling multi-device collaboration.
Data flow
- EasyAR Sense creates and uploads to the server. Map data is downloaded and used when needed. Cache validity should be checked before use.
- The user side sends operation commands to the data management server through APIs.
flowchart TB
B[API or EasyAR Web] --> A[Data management server]
A[Data management server] <--> D[Device EasyAR Sense] <--> C>Device data cache]
Data center
Consider network distribution data centers. Users should select the region corresponding to the server network before purchasing. Currently supported regions include:
- China region
- North America region
Method 1: managing spatial maps in EasyAR development center
Suitable for small-scale business scenarios. Operation steps are as follows:
- Log in to the EasyAR development center and enter SpatialMap.
- Select China region or North America region. If no SpatialMap library has been created, create a new SpatialMap library first.
- Since EasyAR SpatialMap is bound to EasyAR Sense, the operation is to create a SpatialMap library in the Sense License Key page.
- Sense authorization -> SpatialMap

- Click Manage in the library list to enter the SpatialMap list. Click Manage for any spatial map, as shown in the figure, and perform the following management operations on a single spatial map:
- Delete operation
- Update operation (mark 1): disable/enable map
- Update operation (mark 2): modify name
- Update operation (mark 3): modify label
- Update operation (mark 4): modify location: GNSS/GPS
- Update operation (mark 5): modify meta: associate url resources, custom attributes

Method 2: using rest api for automated management
For scenarios requiring handling large amounts of map management, it is recommended to use Web Service REST APIs to implement automated workflows in your application or management backend.
Prepare resource list
- SpatialMap AppId
- Authentication credentials: API Key / API Secret or Token
- Cloud URL: Spatial Map service request addresses are divided by data center. China (default) and North America are:
- China region:
https://armap-api.easyar.com - North America region:
https://armap-api-na1.easyar.com
- China region:
Obtain list resources
- Obtain SpatialMap AppId:
Development center -> SpatialMap -> Select library -> Manage -> Authentication

- Obtain API Key / API Secret:
Development center -> Cloud service APIKey -> Copy

If you don't have an API Key yet, create one. You must select SpatialMap permissions. Learn more about API Key and permission control in the topic API Key introduction

- Obtain Token:
Development center -> Cloud service APIKey -> Manage -> Select validity period -> Generate Token -> Copy

If you need to customize the Token's validity period, refer to the UAC API - Create Token method, using the original APIKey and APISecret to create the Token
Multi-end integration guide
In actual workflows, spatial map management is usually integrated into the developer's business server, mobile end, or Unity:
Business service platform: Provides sample code for calling APIs in common server development languages (Curl/Java/NodeJS/PHP) to help developers implement spatial map management.
Mobile end (Unity/Mobile): Developers can use Unity to develop and create spatial maps, then manage spatial maps based on Unity.