Table of Contents

API - Get the download address of meta data

This interface is used to get the download resource information of metadata (meta) associated with the specified Spatial Map through mapId.

1. Basic interface information

  • Interface address: https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId}
  • Request method: GET
  • Response format: */* (usually application/json)

2. Authentication method

This interface supports the following two authentication modes:

  1. Token-based authentication:
    • Header: Authorization: [token]
    • Parameter: AppId must be included.
  2. Signature-based authentication:
    • Use APIKey, APISecret, and AppId to generate a signature for verification.
    • For the detailed signature calculation algorithm, refer to API Key signature method.

3. Request parameters

3.1 Path parameters

Parameter name Type Required Description
mapId String Yes Unique identifier of the spatial map (MapId).

4. Response data structure (Resource)

When the request succeeds (statusCode is 0), the returned result contains a Resource object pointing to the metadata file.

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

Resource object structure:

Field name Type Description
filename String File name of the metadata file.
url Object (URL) Object containing detailed download address information such as protocol, host, and path.
file Object (File) Physical property information of the file, such as path and size.
readable Boolean Whether the resource is readable.
open Boolean Whether the resource is currently open.

5. Status codes

Http Code Meaning Description
200 OK Request succeeded.
401 Unauthorized Authentication failed. Check the Token or signature.
403 Forbidden No permission to access this resource.
404 Not Found The specified map or metadata was not found.

Status Code error codes

6. Example response (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "filename": "map_metadata.json",
    "url": {
      "protocol": "https",
      "host": "armap-api-cn1.easyar.com",
      "path": "/download/path/to/meta",
      "query": "token=..."
    },
    "readable": true,
    "open": false
  }
}