Table of Contents

API —— Get download address for meta data

This interface is used to obtain the download resource information for the metadata (meta) associated with a specific Spatial Map by its mapId.

1. Basic interface information

  • Endpoint: https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId}
  • HTTP Method: GET
  • Response Format: */* (Typically application/json)

2. Authentication methods

This interface supports the following two authentication modes:

  1. Token-based authentication:
    • Header: Authorization: [token]
    • Parameter: Must include AppId.
  2. Signature-based authentication:
    • Uses APIKey, APISecret, and AppId to generate a signature for verification.
    • For 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 The unique identifier (MapId) of the Spatial Map.

4. Response data structure (Resource)

When the request is successful (statusCode is 0), the returned result will contain a Resource object pointing to the metadata file.

Field name 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 the map data array and pagination statistics.

Resource object structure:

Field name Type Description
filename String The filename of the metadata file.
url Object (URL) An object containing detailed download address information such as protocol, host, path, etc.
file Object (File) Physical attribute information of the file (e.g., path, 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. Please check the Token or signature.
403 Forbidden Access to the resource is forbidden.
404 Not Found The specified map or metadata was not found.

Status code errors

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