API —— 獲取 meta 資料的下載地址
此介面用於透過 mapId 取得指定 Spatial Map(空間地圖)關聯元資料(meta)的下載資源資訊。
1. 介面基本資訊
- 介面地址:
https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId} - 請求方法:
GET - 響應格式:
*/*(通常為application/json)
2. 認證方式
此介面支援以下兩種鑑權模式:
- 基於 Token 認證:
- Header:
Authorization: [token] - 參數:需附帶
AppId。
- Header:
- 基於簽名(Signature)認證:
- 使用
APIKey、APISecret和AppId產生簽名進行校驗。 - 簽名計算的詳細演算法,參考 API Key 簽名方法。
- 使用
3. 請求參數
3.1 路徑參數 (Path Parameters)
| 參數名稱 | 類型 | 是否必選 | 描述 |
|---|---|---|---|
| mapId | String | 是 | 空間地圖的唯一識別碼(MapId)。 |
4. 響應資料結構 (Resource)
當請求成功(statusCode 為 0)時,返回結果 result 將包含指向元資料檔案的 Resource 物件。
| 欄位名稱 | 類型 | 描述 |
|---|---|---|
| statusCode | Integer | 狀態碼。0 代表成功。 |
| msg | String | 狀態描述資訊。 |
| timestamp | DateTime | 伺服器響應時間戳。 |
| result | Object | 包含地圖資料陣列及分頁統計資訊的 Map 物件。 |
Resource 物件結構:
| 欄位名稱 | 類型 | 描述 |
|---|---|---|
| filename | String | 元資料檔案的檔名。 |
| url | Object (URL) | 包含協定、主機、路徑等詳細下載地址資訊的物件。 |
| file | Object (File) | 檔案的實體屬性資訊(如路徑、大小等)。 |
| readable | Boolean | 此資源是否可讀。 |
| open | Boolean | 此資源目前是否處於開啟狀態。 |
5. 狀態碼 (Status Codes)
| Http Code | 含義 | 說明 |
|---|---|---|
| 200 | OK | 請求成功。 |
| 401 | Unauthorized | 認證失敗,請檢查 Token 或簽名。 |
| 403 | Forbidden | 無權存取此資源。 |
| 404 | Not Found | 未找到指定的地圖或元資料。 |
Status Code 錯誤碼
6. 範例響應 (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
}
}