API —— Spatial Map 地図リストの取得

このインターフェースは、現在の画像ライブラリ下のすべてのSpatial Map（空間地図）のリスト情報をページネーションで取得するために使用されます。

1. インターフェース基本情報

インターフェースアドレス: https://armap-api-<cn1,na1>.easyar.com/maps
リクエスト方法: GET
レスポンス形式: */* (通常は application/json)

2. 認証方式

このインターフェースは以下の2つの認証モードをサポートしています：

Tokenベース認証:
- Header: Authorization: [token]
- パラメータ: AppId を付帯する必要があります。
署名（Signature）ベース認証:
- APIKey、APISecret、AppIdとパラメータを使用して署名を生成し、検証します。
- 署名計算の詳細なアルゴリズムは、API Key 署名方法を参照してください。

3. リクエストパラメータ

3.1 クエリパラメータ (Query Parameters)

ページネーションパラメータはオプションです。入力しない場合、デフォルト値が使用されます。

パラメータ名	タイプ	必須かどうか	デフォルト値	説明
pageNum	Integer	否	1	リクエスト対象のページ番号。
pageSize	Integer	否	10	1ページあたりの表示可能な最大地図数。

4. レスポンスデータ構造 (ResponseResult)

リクエストが成功した場合（statusCode が 0）、結果 result には地図リストとそのページネーションのメタデータが含まれます。

フィールド名	タイプ	説明
statusCode	Integer	ステータスコード。0 は成功を表します。
msg	String	ステータス説明情報。
timestamp	DateTime	サーバー応答タイムスタンプ。
result	Object	地図データ配列とページネーション統計情報を含む Map オブジェクト。

5. ステータスコード

HTTP コード	意味	説明
200	OK	リクエスト成功。
401	Unauthorized	認証失敗。Token または署名を確認してください。
403	Forbidden	当該リソースへのアクセス権限がありません。
404	Not Found	関連リソースが見つかりません。

Status Code エラーコード

疎空間地図 APIs エラーコード説明

6. レスポンス例 (JSON)

{
  "result": {
    "armaps": [
      {
        "mapId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "gps": "[0.0, 0.0]",
        "name": "Map_2020-09-28_1302",
        "size": 124140,
        "status": "active",
        "auxiliaryId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "created": 1601245841687,
        "modified": 1601245841687,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "appKey": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9f.."
      },
      {
        "mapId": "5ccdf1fb-0cd3-4580-80aa-42bd2289...",
        "gps": "[0.0, 0.0]",
        "name": "test",
        "size": 2419184,
        "status": "active",
        "auxiliaryId": "5ccdf1fb-0cd3-4580-80aa-42bd22897b...",
        "floor": "1",
        "tag": "cat",
        "created": 1601244090670,
        "modified": 1601244090670,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley....",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...."
      }
    ],
    "page": {
      "total": 2,
      "pageNum": 1,
      "pageSize": 10,
      "pages": 1
    }
  },
  "statusCode": 0,
  "msg": "Success",
  "timestamp": 1769406021019
}

Table of Contents