API —— Spatial Map 検索
このインターフェースは Spatial Map(空間マップ)の検索に使用されます。検索パラメータはすべてオプションです。複数のフィールドで検索する場合、システムは "AND" ロジックで条件を結合します。
1. インターフェース基本情報
- インターフェースアドレス:
https://armap-api-<cn1,na1>.easyar.com/map - リクエストメソッド:
GET - レスポンス形式:
*/*(通常はapplication/json)
2. 認証方式
このインターフェースは以下の2つの認証モードをサポートします:
- Token ベース認証:
- Header:
Authorization: [token] - パラメータ:
AppIdが必要です。
- Header:
- 署名(Signature)ベース認証:
APIKey、APISecret、AppIdとパラメータを使用して署名を生成し検証します。- 署名計算の詳細なアルゴリズムは、API Key 署名方法 を参照してください。
3. リクエストパラメータ
3.1 クエリパラメータ (Query Parameters)
すべての検索パラメータはオプションです。
| パラメータ名 | タイプ | 必須 | デフォルト値 | 説明 |
|---|---|---|---|---|
| gps | String | 否 | - | この GPS 座標付近のマップを検索します。 |
| range | Number | 否 | 1.0 | 検索範囲(単位: km)。gps パラメータと併用必須です。 |
| name | String | 否 | - | マップ名で検索します。 |
| tag | String | 否 | - | マップタグで検索します。 |
4. レスポンスデータ構造 (ARMapDTO)
リクエスト成功時(statusCode が 0)は、結果 result に条件に一致するマップオブジェクトの配列が含まれます。
| フィールド名 | タイプ | 説明 |
|---|---|---|
| statusCode | Integer | ステータスコード。0 は成功を示します。 |
| msg | String | ステータス説明情報。 |
| timestamp | DateTime | サーバー応答タイムスタンプ。 |
| result | Array | ARMapDTO オブジェクトの配列。 |
ARMapDTO オブジェクト構造
| フィールド名 | タイプ | 説明 |
|---|---|---|
| mapId | String | マップの一意識別子。 |
| name | String | マップ名。 |
| status | String | マップの現在のステータス。 |
| size | Integer (int64) | マップファイルサイズ。 |
| gps | String | マップに関連付けられた GPS 座標情報。 |
| tag | String | マップタグ。 |
| meta | String | カスタムメタデータ。 |
| created | DateTime | 作成日時。 |
| modified | DateTime | 最終更新日時。 |
5. ステータスコード (Status Codes)
| Http Code | 意味 | 説明 |
|---|---|---|
| 200 | OK | リクエスト成功。 |
| 401 | Unauthorized | 認証失敗。Token または署名を確認してください。 |
| 403 | Forbidden | リソースへのアクセス権限がありません。 |
Status Code エラーコード
6. レスポンス例 (JSON)
{
"statusCode": 0,
"msg": "success",
"timestamp": "2026-01-30T10:00:00Z",
"result": [
{
"mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
"name": "office_scene",
"status": "active",
"gps": "121.4541,31.2221",
"tag": "indoor"
}
]
}