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 | カスタム metadata。 |
| 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"
}
]
}